com.clicksend.controllers.syncwrapper

Class APICallBackCatcher<T>

java.lang.Object

com.clicksend.controllers.syncwrapper.SynchronousBase

com.clicksend.controllers.syncwrapper.APICallBackCatcher<T>

Type Parameters:

T - Type of the response object

All Implemented Interfaces:

APICallBack<T>

public class APICallBackCatcher<T>
extends SynchronousBase
implements APICallBack<T>

An APICallBack that captures the HTTP response and can be waited on An instance of this class can be passed to an API call as the APICallBack instance to capture the results of that call. Call await() to block until completion of the API call. Trying to get results of API call before calling wait() will also block.

Constructor Summary

Constructors

Constructor and Description
APICallBackCatcher()

Method Summary

Modifier and Type	Method and Description
Throwable	getError() Get the exception object thrown by this API callback if any.
T	getResult() Get the result from the API callback.
boolean	isSuccess() Was the API call successful? Blocks if API call is not complete yet.
void	onFailure(HttpContext responseContext, Throwable error) OnFailure handler for APICallBack.
void	onSuccess(HttpContext context, T response) On Success handler for APICallBack.

Methods inherited from class com.clicksend.controllers.syncwrapper.SynchronousBase

await, await, markAsDone

Methods inherited from class java.lang.Object

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

Constructor Detail

APICallBackCatcher

public APICallBackCatcher()

Method Detail

getResult

public T getResult()
            throws Throwable

Get the result from the API callback. Blocks if API call is not complete yet.

Returns:

Throws:

Throwable

getError

public Throwable getError()
                   throws InterruptedException

Get the exception object thrown by this API callback if any. Blocks if API call is not complete yet.

Returns:

Throws:

InterruptedException

isSuccess

public boolean isSuccess()
                  throws InterruptedException

Was the API call successful? Blocks if API call is not complete yet.

Returns:

Throws:

InterruptedException

onSuccess

public void onSuccess(HttpContext context,
                      T response)

On Success handler for APICallBack.

Specified by:

onSuccess in interface APICallBack<T>

Parameters:

context - The context of the API request

response - The response received from the API Call

onFailure

public void onFailure(HttpContext responseContext,
                      Throwable error)

OnFailure handler for APICallBack.

Specified by:

onFailure in interface APICallBack<T>

Parameters:

responseContext - The context of the API request

error - Any error detected during the API Call and/or deserialization