digital.bakehouse.rxusecase

Class Response<O>

java.lang.Object

digital.bakehouse.rxusecase.Response<O>

Type Parameters:

O - Output type

public class Response<O>
extends java.lang.Object

Data holder acting as a wrapper of the success and/or failure data. Instances of this class are emitted by use-cases as outputs for the action/logic/mechanism they wrap/define.

Constructor Summary

Constructors

Constructor and Description
Response(O data, Failure failure) Wrap success data and failure object

Method Summary

Modifier and Type	Method and Description
static Response<java.lang.Void>	empty() Factory method to create a Void wrapped success Response object.
boolean	equals(java.lang.Object o)
static <O> Response<O>	fail(Failure failure) Factory method to wrap a failure into a Response object.
static <O> Response<O>	fail(Response<?> response) Factory method that builds a O typed failure @link Response} object, from the failure of passed input
static <O> Response<O>	fail(java.lang.String errorCode, java.lang.String errorMessage) Factory method to wrap the passed code and message into a failure Response object.
O	getData()
Failure	getFailure()
int	hashCode()
boolean	isSuccessful() Verify whether this Response is a wrapper of success or failure data.
static <O> Response<O>	succeed(O output) Factory method to wrap success data into a Response object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response(O data,
                Failure failure)

Wrap success data and failure object

Parameters:

data - Success

failure - Failure

Method Detail

getData

public O getData()

getFailure

public Failure getFailure()

isSuccessful

public boolean isSuccessful()

Verify whether this Response is a wrapper of success or failure data.

Returns:

true if success holder, false if failure holder

succeed

public static <O> Response<O> succeed(O output)

Factory method to wrap success data into a Response object.

Type Parameters:

O - Output type

Parameters:

output - Success data

Returns:

Response object

fail

public static <O> Response<O> fail(Failure failure)

Factory method to wrap a failure into a Response object.

Type Parameters:

O - Output type

Parameters:

failure - Failure data

Returns:

Response object

fail

public static <O> Response<O> fail(java.lang.String errorCode,
                                   java.lang.String errorMessage)

Factory method to wrap the passed code and message into a failure Response object.

Type Parameters:

O - Output type

Parameters:

errorCode - Failure code

errorMessage - Failure message

Returns:

Response object

fail

public static <O> Response<O> fail(Response<?> response)

Factory method that builds a O typed failure @link Response} object, from the failure of passed input

Type Parameters:

O - Output type

Parameters:

response - Failure data holder

Returns:

Response object

empty

public static Response<java.lang.Void> empty()

Factory method to create a Void wrapped success Response object.

Returns:

Response object

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