com.contentful.java.cma

Class CMACallback<T>

java.lang.Object

com.contentful.java.cma.CMACallback<T>

Type Parameters:

T - the type of object to be expected as a result. For methods that return a collection of resources it is required to use CMAArray as the type.

Callback can be cancelled at any point using the cancel() method, that will prevent any future calls to onSuccess(T) and onFailure(RuntimeException).

public abstract class CMACallback<T>
extends Object

Callback to be used with any of the CMAClient asynchronous methods.

Implement the onSuccess(T) method for cases where the request was successful, the result object should be delivered as a parameter.

It is also possible, but not mandatory to override onFailure(java.lang.RuntimeException) and provide an implementation for handling errors.

Constructor Summary

Constructors

Constructor and Description
CMACallback()

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels this callback.
boolean	isCancelled()
protected void	onFailure(RuntimeException exception) Callback to be invoked in case the request was unsuccessful.
protected abstract void	onSuccess(T result) Callback to be invoked in case the request was successful.

Methods inherited from class java.lang.Object

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

Constructor Detail

CMACallback

public CMACallback()

Method Detail

onSuccess

protected abstract void onSuccess(T result)

Callback to be invoked in case the request was successful.

Parameters:

result - result object

onFailure

protected void onFailure(RuntimeException exception)

Callback to be invoked in case the request was unsuccessful.

Parameters:

exception{@link - RuntimeException} instance

cancel

public void cancel()

Cancels this callback. This will prevent any future calls to onSuccess(Object) and onFailure(RuntimeException) methods. This action cannot be reversed.

isCancelled

public boolean isCancelled()

Returns:

true in case this callback instance was previously canceled.