com.airg.android.async.promise

Class SimplePromise<RESULT>

java.lang.Object

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

All Implemented Interfaces:

Promise<RESULT>

public class SimplePromise<RESULT>
extends java.lang.Object
implements Promise<RESULT>

An implementation of Promise that can be retrofitted into any asynchronous flow:

1. Instantiate a SimplePromise
2. Interact with the SimplePromise instance in your runnable running in the background
3. Return the instantiated SimplePromise in the calling thread

 
 public Promise<MyResult> getResultAsync () {
 final Promise<MyResult> promise = new SimplePromise<MyResult> ()

 executor.execute (new Runnable () {
 public void run () {
 try {
 promise.success (getResultFromNetworkOrDiskOrWhatever ());
 } catch (Exception e) {
 promise.failed (e);
 }
 }
 });

 return promise;
 }
 
 

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
SimplePromise()
SimplePromise(java.util.concurrent.Executor executor)

Method Summary

Modifier and Type	Method and Description
void	cancelled() Mark task as cancelled
void	failed(java.lang.Throwable t) Mark task as failed and provide a cause
boolean	isCancelled() Was the task cancelled?
boolean	isDone() Are we there yet?
boolean	isFailed() Did the task fail?
SimplePromise<RESULT>	onCancel(Promise.OnCancelListener listener) Set cancellation callback
SimplePromise<RESULT>	onComplete(Promise.OnCompleteListener<RESULT> listener) Set completion callback
SimplePromise<RESULT>	onFail(Promise.OnFailListener listener) Set failure callback
boolean	succeeded() Was the promise successfully completed?
void	success(RESULT r) Report task result and mark task as done

Methods inherited from class java.lang.Object

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

Constructor Detail

SimplePromise

public SimplePromise()

SimplePromise

public SimplePromise(java.util.concurrent.Executor executor)

Method Detail

success

public void success(RESULT r)

Report task result and mark task as done

Parameters:

r - obtained result

failed

public void failed(java.lang.Throwable t)

Mark task as failed and provide a cause

Parameters:

t - cause of the failure

cancelled

public void cancelled()

Mark task as cancelled

onComplete

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

Set completion callback

Specified by:

onComplete in interface Promise<RESULT>

Parameters:

listener - listener to notify on completion

Returns:

this Promise to chain more callbacks

onFail

public SimplePromise<RESULT> onFail(Promise.OnFailListener listener)

Set failure callback

Specified by:

onFail in interface Promise<RESULT>

Parameters:

listener - listener to notify on failure.

Returns:

this Promise to chain more callbacks

onCancel

public SimplePromise<RESULT> onCancel(Promise.OnCancelListener listener)

Set cancellation callback

Specified by:

onCancel in interface Promise<RESULT>

Parameters:

listener - listener to notify on cancellation

Returns:

this Promise to chain more callbacks

isDone

public boolean isDone()

Are we there yet?

Specified by:

isDone in interface Promise<RESULT>

Returns:

true if task is complete and false otherwise

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

isFailed

public boolean isFailed()

Did the task fail?

Specified by:

isFailed in interface Promise<RESULT>

Returns:

true if failed and false otherwise

isCancelled

public boolean isCancelled()

Was the task cancelled?

Specified by:

isCancelled in interface Promise<RESULT>

Returns:

true if cancelled and false otherwise