com.airg.android.async.promise

Class FuturePromise<RESULT>

java.lang.Object

java.util.concurrent.FutureTask<RESULT>

com.airg.android.async.promise.FuturePromise<RESULT>

All Implemented Interfaces:

Promise<RESULT>, java.lang.Runnable, java.util.concurrent.Future<RESULT>, java.util.concurrent.RunnableFuture<RESULT>

public final class FuturePromise<RESULT>
extends java.util.concurrent.FutureTask<RESULT>
implements Promise<RESULT>

A FutureTask that implements the Promise interface to provide completion, failure, and cancellation callbacks. By default, the callbacks run on the same thread that executes this task. To force a specific thread, provide an Executor to FuturePromise(Callable, Executor) or FuturePromise(Runnable, Object, Executor)

Nested Class Summary

Nested classes/interfaces inherited from interface com.airg.android.async.promise.Promise

Promise.OnCancelListener, Promise.OnCompleteListener<RESULT>, Promise.OnFailListener

Constructor Summary

Constructors

Constructor and Description
FuturePromise(java.util.concurrent.Callable<RESULT> callable) Wrap a Callable
FuturePromise(java.util.concurrent.Callable<RESULT> callable, java.util.concurrent.Executor executor) Wrap a Callable and provide an Executor for the callbacks.
FuturePromise(java.lang.Runnable runnable, RESULT resultHolder) Wrap a Runnable
FuturePromise(java.lang.Runnable runnable, RESULT resultHolder, java.util.concurrent.Executor executor) Wrap a Runnable and provide an Executor for the callbacks.

Method Summary

Modifier and Type	Method and Description
protected void	done()
boolean	isFailed() See Promise.isFailed()
FuturePromise<RESULT>	onCancel(Promise.OnCancelListener listener) See Promise.onCancel(OnCancelListener)
FuturePromise<RESULT>	onComplete(Promise.OnCompleteListener<RESULT> listener) See Promise.onComplete(OnCompleteListener)
FuturePromise<RESULT>	onFail(Promise.OnFailListener listener) See Promise.onFail(OnFailListener)
boolean	succeeded() Was the promise successfully completed?

Methods inherited from class java.util.concurrent.FutureTask

cancel, get, get, isCancelled, isDone, run, runAndReset, set, setException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.airg.android.async.promise.Promise

isCancelled, isDone

Constructor Detail

FuturePromise

public FuturePromise(java.util.concurrent.Callable<RESULT> callable)

Wrap a Callable

Parameters:

callable - callable to get the result from

FuturePromise

public FuturePromise(java.util.concurrent.Callable<RESULT> callable,
                     java.util.concurrent.Executor executor)

Wrap a Callable and provide an Executor for the callbacks.

Parameters:

callable - callable to get the result from

executor - an Executor on which the callbacks will execute

FuturePromise

public FuturePromise(java.lang.Runnable runnable,
                     RESULT resultHolder)

Wrap a Runnable

Parameters:

runnable - Runnable to get the result from

resultHolder - The result placeholder

FuturePromise

public FuturePromise(java.lang.Runnable runnable,
                     RESULT resultHolder,
                     java.util.concurrent.Executor executor)

Wrap a Runnable and provide an Executor for the callbacks.

Parameters:

runnable - Runnable to get the result from

resultHolder - The result placeholder

executor - an Executor on which the callbacks will execute

Method Detail

succeeded

public boolean succeeded()

Was the promise successfully completed?

Specified by:

succeeded in interface Promise<RESULT>

Returns:

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

onComplete

public final FuturePromise<RESULT> onComplete(Promise.OnCompleteListener<RESULT> listener)

See Promise.onComplete(OnCompleteListener)

Specified by:

onComplete in interface Promise<RESULT>

Parameters:

listener - listener to notify on completion

Returns:

this instance to chain more callbacks

onFail

public final FuturePromise<RESULT> onFail(Promise.OnFailListener listener)

See Promise.onFail(OnFailListener)

Specified by:

onFail in interface Promise<RESULT>

Parameters:

listener - listener to notify on failure.

Returns:

this instance to chain more callbacks

onCancel

public final FuturePromise<RESULT> onCancel(Promise.OnCancelListener listener)

See Promise.onCancel(OnCancelListener)

Specified by:

onCancel in interface Promise<RESULT>

Parameters:

listener - listener to notify on cancellation

Returns:

this instance to chain more callbacks

isFailed

public boolean isFailed()

See Promise.isFailed()

Specified by:

isFailed in interface Promise<RESULT>

Returns:

true if task has failed, false otherwise

done

protected void done()

Overrides:

done in class java.util.concurrent.FutureTask<RESULT>