com.baasbox.android

Class BaasResult<T>

java.lang.Object

com.baasbox.android.BaasResult<T>

public abstract class BaasResult<T>
extends java.lang.Object

This class represents the result of a BaasBox request. It can be either a successful response or a failure due to an error or an user cancellation.

Since:

0.7.3

Method Summary

Modifier and Type	Method and Description
static <T> BaasResult<T>	cancel() Returns a new canceled BaasResult
abstract BaasException	error() Returns the error represented by this result or null if this result is not an error.
static <T> BaasResult<T>	failure(BaasException t) Returns a new failed BaasResult
abstract T	get() Tries to return the value if there was an error it will be thrown instead.
abstract boolean	isCanceled() True if this result represent a cancelled request
abstract boolean	isFailed() True if this result represents a failure
abstract boolean	isSuccess() True if the result represent a success
static <T> BaasResult<T>	success(T result) Returns a new successful BaasResult
abstract T	value() Returns the value represented by this result if there was no error, null otherwise

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

failure

public static <T> BaasResult<T> failure(BaasException t)

Returns a new failed BaasResult

Type Parameters:

T -

Parameters:

t -

Returns:

cancel

public static <T> BaasResult<T> cancel()

Returns a new canceled BaasResult

Type Parameters:

T -

Returns:

success

public static <T> BaasResult<T> success(T result)

Returns a new successful BaasResult

Type Parameters:

T -

Parameters:

result -

Returns:

error

public abstract BaasException error()

Returns the error represented by this result or null if this result is not an error.

Returns:

a BaasException

get

public abstract T get()
               throws BaasException

Tries to return the value if there was an error it will be thrown instead.

Returns:

the value contained in this result

Throws:

BaasException - if the request was canceled or there was an errror

isCanceled

public abstract boolean isCanceled()

True if this result represent a cancelled request

Returns:

true if this result is canceled

isFailed

public abstract boolean isFailed()

True if this result represents a failure

Returns:

true if this result is a failure

isSuccess

public abstract boolean isSuccess()

True if the result represent a success

Returns:

true if this result is a success

value

public abstract T value()

Returns the value represented by this result if there was no error, null otherwise

Returns:

a value