com.airg.android.async.promise

Class AbstractPromise<RESULT>

java.lang.Object

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

All Implemented Interfaces:

Promise<RESULT>, java.lang.Runnable

public abstract class AbstractPromise<RESULT>
extends java.lang.Object
implements Promise<RESULT>, java.lang.Runnable

Another implementation for Promise. Override the bits that do work and this will do the rest.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static TaggedLogger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPromise() Default constructor.
protected	AbstractPromise(java.util.concurrent.Executor executor) Alternate constructor.

Method Summary

Modifier and Type	Method and Description
protected void	abort() Called when a cancel request is received and before the OnCancelListener#onCancelled() is called.
void	cancel() Final method.
boolean	isCancelled() See Promise.isCancelled()
boolean	isDone() See Promise.isDone()
boolean	isFailed() See Promise.isFailed()
AbstractPromise<RESULT>	onCancel(Promise.OnCancelListener listener) See Promise.onCancel(OnCancelListener)
AbstractPromise<RESULT>	onComplete(Promise.OnCompleteListener<RESULT> listener) See Promise.onComplete(OnCompleteListener)
AbstractPromise<RESULT>	onFail(Promise.OnFailListener listener) See Promise.onFail(OnFailListener)
protected abstract RESULT	result() Obtain the result for this task.
void	run() Final method.
boolean	succeeded() See Promise.succeeded()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final TaggedLogger LOG

Constructor Detail

AbstractPromise

protected AbstractPromise()

Default constructor. Callbacks occur on the executing thread (not ideal for UI).

AbstractPromise

protected AbstractPromise(java.util.concurrent.Executor executor)

Alternate constructor. Callbacks are executed on the provided Executor. For UI use, pass in ThreadPool.foreground() and save yourself the trouble of View.post(Runnable) or Activity.runOnUIThread(Runnable)

Parameters:

executor - executor to execute callbacks on.

Method Detail

run

public final void run()

Final method. Obtains the result and takes care of the success, failure, and cancel reporting.

Specified by:

run in interface java.lang.Runnable

cancel

public final void cancel()

Final method. Marks the task as cancelled. To actually

result

protected abstract RESULT result()
                          throws java.lang.Exception

Obtain the result for this task.

Returns:

your result

Throws:

java.lang.Exception

abort

protected void abort()

Called when a cancel request is received and before the OnCancelListener#onCancelled() is called. If you are able to abort the execution, this is where you do it. Does nothing by default.

onComplete

public AbstractPromise<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 AbstractPromise<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 AbstractPromise<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

isDone

public boolean isDone()

See Promise.isDone()

Specified by:

isDone in interface Promise<RESULT>

Returns:

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

succeeded

public boolean succeeded()

See Promise.succeeded()

Specified by:

succeeded in interface Promise<RESULT>

Returns:

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

isFailed

public boolean isFailed()

See Promise.isFailed()

Specified by:

isFailed in interface Promise<RESULT>

Returns:

true if task has failed, false otherwise

isCancelled

public boolean isCancelled()

See Promise.isCancelled()

Specified by:

isCancelled in interface Promise<RESULT>

Returns:

true if task has been cancelled, false otherwise