com.squareup.sdk.reader.core

Class Result<S,E>

java.lang.Object

com.squareup.sdk.reader.core.Result<S,E>

Type Parameters:

S - The success value if the operation was successful.

E - The error if the operation was not successful.

public final class Result<S,E>
extends java.lang.Object

The result of an asynchronous operation.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
E	getError() The error, if the operation resulted in an error.
S	getSuccessValue() The result of a successful operation.
int	hashCode()
boolean	hasSuccessValue() Returns true if the operation was successful and the generic parameter S is not of type Void, false otherwise.
boolean	isError() true if the operation resulted in an error.
boolean	isSuccess() true if the operation was successful.
static <S,E> Result<S,E>	newError(E error) Creates a new Result object representing an error.
static <E> Result<java.lang.Void,E>	newSuccess() Creates a new Result object representing a success without a success value.
static <S,E> Result<S,E>	newSuccess(S successValue) Creates a new Result object representing a success with a success value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newError

@NonNull
public static <S,E> Result<S,E> newError(@NonNull
                                                  E error)

Creates a new Result object representing an error.

This method is provided for testing purposes.

newSuccess

@NonNull
public static <S,E> Result<S,E> newSuccess(@NonNull
                                                    S successValue)

Creates a new Result object representing a success with a success value.

This method is provided for testing purposes.

newSuccess

@NonNull
public static <E> Result<java.lang.Void,E> newSuccess()

Creates a new Result object representing a success without a success value.

This method is provided for testing purposes.

getSuccessValue

@NonNull
public S getSuccessValue()
                           throws java.lang.IllegalStateException

The result of a successful operation.

Throws:

java.lang.IllegalStateException - if the operation resulted in an error or there was no success value.

hasSuccessValue

public boolean hasSuccessValue()

Returns true if the operation was successful and the generic parameter S is not of type Void, false otherwise.

getError

@NonNull
public E getError()
                    throws java.lang.IllegalStateException

The error, if the operation resulted in an error.

Throws:

java.lang.IllegalStateException - if isError() is false.

isError

public boolean isError()

true if the operation resulted in an error. See getError()} for the cause.

isSuccess

public boolean isSuccess()

true if the operation was successful. See getSuccessValue()} for the result when the generic parameter S is not of type Void.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object