com.airg.android.async.promise

Interface Promise<RESULT>

All Known Implementing Classes:

AbstractPromise, FuturePromise, SimplePromise

public interface Promise<RESULT>

The Promise interface is very similar to a Future, but it provides callbacks for completion, failure, and cancellation

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Promise.OnCancelListener Task cancellation callback
static interface	Promise.OnCompleteListener<RESULT> Task completion callback
static interface	Promise.OnFailListener Task failure callback

Method Summary

Modifier and Type	Method and Description
boolean	isCancelled() Is the task cancelled?
boolean	isDone() Are we there yet?
boolean	isFailed() Did you keep your promise?
Promise<RESULT>	onCancel(Promise.OnCancelListener listener) Add an Promise.OnCancelListener callback to be notified on cancellation
Promise<RESULT>	onComplete(Promise.OnCompleteListener<RESULT> listener) Add an Promise.OnCompleteListener callback to be notified of completion
Promise<RESULT>	onFail(Promise.OnFailListener listener) Add an Promise.OnFailListener callback to be notified on failure
boolean	succeeded() Was the promise successfully completed?

Method Detail

onComplete

Promise<RESULT> onComplete(Promise.OnCompleteListener<RESULT> listener)

Add an Promise.OnCompleteListener callback to be notified of completion

Parameters:

listener - listener to notify on completion

Returns:

this instance to chain more callbacks

onFail

Promise<RESULT> onFail(Promise.OnFailListener listener)

Add an Promise.OnFailListener callback to be notified on failure

Parameters:

listener - listener to notify on failure.

Returns:

this instance to chain more callbacks

onCancel

Promise<RESULT> onCancel(Promise.OnCancelListener listener)

Add an Promise.OnCancelListener callback to be notified on cancellation

Parameters:

listener - listener to notify on cancellation

Returns:

this instance to chain more callbacks

isDone

boolean isDone()

Are we there yet?

Returns:

true if task has run to completion (including due to failure or cancellation), false otherwise

succeeded

boolean succeeded()

Was the promise successfully completed?

Returns:

true if task was able to successfully obtain a result, false otherwise

isFailed

boolean isFailed()

Did you keep your promise?

Returns:

true if task has failed, false otherwise

isCancelled

boolean isCancelled()

Is the task cancelled?

Returns:

true if task has been cancelled, false otherwise