cloud.timo.TimoCloud.api.async

Interface APIRequestFuture<T>

public interface APIRequestFuture<T>

Method Summary

Modifier and Type	Method and Description
T	awaitResponse() Stops the current thread to wait for a response and returns it when it arrived
APIRequest<T>	getAPIRequest()
APIRequestError	getError()
Collection<APIRequestErrorHandler>	getErrorHandlers()
Collection<APIRequestFutureListener<T>>	getListeners()
T	getResponse()
boolean	isCompleted()
Boolean	isSuccess()
APIRequestFuture<T>	onCompletion(APIRequestFutureListenerWithoutParams<T> listener)
APIRequestFuture<T>	onCompletion(APIRequestFutureListenerWithParams<T> listener)
APIRequestFuture<T>	onError(APIRequestErrorHandler handler)
APIRequestFuture<T>	removeErrorHandler(APIRequestErrorHandler errorHandler)
APIRequestFuture<T>	removeListener(APIRequestFutureListener<T> listener)

Method Detail

onCompletion

APIRequestFuture<T> onCompletion(APIRequestFutureListenerWithoutParams<T> listener)

Parameters:

listener - Will be called if the APIRequest was successful and a response arrived

Returns:

The same APIRequestFuture this call is made on, for chaining statements

onCompletion

APIRequestFuture<T> onCompletion(APIRequestFutureListenerWithParams<T> listener)

Parameters:

listener - Will be called if the APIRequest was successful and a response arrived

Returns:

The same APIRequestFuture this call is made on, for chaining statements

onError

APIRequestFuture<T> onError(APIRequestErrorHandler handler)

Parameters:

handler - Will be called when an error is returned because of an invalid request

Returns:

The same APIRequestFuture this call is made on, for chaining statements

isCompleted

boolean isCompleted()

Returns:

Whether the APIRequest has been completed or not

isSuccess

Boolean isSuccess()

Returns:

Whether the APIRequest was successful or not. If the request is not completed yet, this will return null.

getAPIRequest

APIRequest<T> getAPIRequest()

Returns:

The APIRequest this future belongs to

getResponse

T getResponse()

Returns:

If no response has arrived yet or an error has occurred, this will return null

getError

APIRequestError getError()

Returns:

If an error occurred while processing the APIRequest, this method will return it - otherwise null

awaitResponse

T awaitResponse()
         throws APIRequestError

Stops the current thread to wait for a response and returns it when it arrived

Returns:

The respoonse to the API request

Throws:

APIRequestError - An APIRequestError might be thrown if the API request is not valid

removeListener

APIRequestFuture<T> removeListener(APIRequestFutureListener<T> listener)

Parameters:

listener - The given listener will not be notified about the APIRequest's response

Returns:

The same APIRequestFuture this call is made on, for chaining statements

removeErrorHandler

APIRequestFuture<T> removeErrorHandler(APIRequestErrorHandler errorHandler)

Parameters:

errorHandler - The given error handler will not be notified about an error returned to the APIRequest

Returns:

The same APIRequestFuture this call is made on, for chaining statements

getListeners

Collection<APIRequestFutureListener<T>> getListeners()

Returns:

All listeners listening to this future

getErrorHandlers

Collection<APIRequestErrorHandler> getErrorHandlers()

Returns:

All error handlers listening to this future