com.englishtown.promises

Class WhenProgress.TrustedPromise

java.lang.Object

com.englishtown.promises.WhenProgress.TrustedPromise

All Implemented Interfaces:

ProgressPromise<TResolve,TProgress>, PromiseExt<TResolve,TProgress>, Thenable<TResolve,TProgress>

Direct Known Subclasses:

WhenProgress.FulfilledPromise, WhenProgress.ProgressingPromise, WhenProgress.Promise0, WhenProgress.RejectedPromise

Enclosing class:

WhenProgress<TResolve,TProgress>

protected abstract class WhenProgress.TrustedPromise
extends Object
implements PromiseExt<TResolve,TProgress>

Field Summary

Fields

Modifier and Type	Field and Description
protected PromiseStatus	_status

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WhenProgress.TrustedPromise()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	_when(Runnable<Void,Thenable<TResolve,TProgress>> resolve, Runnable<Void,Value<TProgress>> notify, Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled, Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected, Runnable<Value<TProgress>,Value<TProgress>> onProgress) Private message delivery.
ProgressPromise<TResolve,TProgress>	always(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilledOrRejected) Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected)
WhenProgress.TrustedPromise	always(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilledOrRejected, Runnable<Value<TProgress>,Value<TProgress>> onProgress) Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected)
WhenProgress.TrustedPromise	done(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> handleResult, Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> handleError) Terminate a promise chain by handling the ultimate fulfillment value or rejection reason, and assuming responsibility for all errors.
WhenProgress.TrustedPromise	ensure(Runnable<? extends ProgressPromise<TResolve,TProgress>,Void> onFulfilledOrRejected) Ensures that onFulfilledOrRejected will be called regardless of whether this promise is fulfilled or rejected.
abstract PromiseState<TResolve>	inspect() Returns the current state of a promise
WhenProgress.TrustedPromise	otherwise(Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected) Register a rejection handler.
WhenProgress.TrustedPromise	tap(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilledSideEffect) Runs a side effect when this promise fulfills, without changing the fulfillment value.
WhenProgress.TrustedPromise	then(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled) Register handlers for this promise.
WhenProgress.TrustedPromise	then(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled, Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected) Register handlers for this promise.
WhenProgress.TrustedPromise	then(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled, Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected, Runnable<Value<TProgress>,Value<TProgress>> onProgress) Register handlers for this promise.
WhenProgress.TrustedPromise	yield(Thenable<TResolve,TProgress> value) Shortcut for .then(function() { return value; })
ProgressPromise<TResolve,TProgress>	yield(TResolve value) Shortcut for .then(function() { return resolve(value); })

Methods inherited from class java.lang.Object

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

Field Detail

_status

protected PromiseStatus _status

Constructor Detail

WhenProgress.TrustedPromise

protected WhenProgress.TrustedPromise()

Method Detail

_when

protected abstract void _when(Runnable<Void,Thenable<TResolve,TProgress>> resolve,
         Runnable<Void,Value<TProgress>> notify,
         Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled,
         Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected,
         Runnable<Value<TProgress>,Value<TProgress>> onProgress)

Private message delivery. Queues and delivers messages to the promise's ultimate fulfillment value or rejection reason.

inspect

public abstract PromiseState<TResolve> inspect()

Description copied from interface: PromiseExt

Returns the current state of a promise

Specified by:

inspect in interface PromiseExt<TResolve,TProgress>

Returns:

then

public WhenProgress.TrustedPromise then(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled,
                               Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected,
                               Runnable<Value<TProgress>,Value<TProgress>> onProgress)

Register handlers for this promise.

Specified by:

then in interface Thenable<TResolve,TProgress>

Parameters:

onFulfilled - {Function} fulfillment handler

onRejected - {Function} rejection handler

onProgress - {Function} progress handler

Returns:

{Promise} new Promise

then

public WhenProgress.TrustedPromise then(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled,
                               Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected)

Register handlers for this promise.

Specified by:

then in interface ProgressPromise<TResolve,TProgress>

Parameters:

onFulfilled - {Function} fulfillment handler

onRejected - {Function} rejection handler

Returns:

{Promise} new Promise

then

public WhenProgress.TrustedPromise then(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilled)

Register handlers for this promise.

Specified by:

then in interface ProgressPromise<TResolve,TProgress>

Parameters:

onFulfilled - {Function} fulfillment handler

Returns:

{Promise} new Promise

otherwise

public WhenProgress.TrustedPromise otherwise(Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> onRejected)

Register a rejection handler. Shortcut for .then(undefined, onRejected)

Specified by:

otherwise in interface PromiseExt<TResolve,TProgress>

Parameters:

onRejected - the callback for when a promise is rejected

Returns:

a new promise

ensure

public WhenProgress.TrustedPromise ensure(Runnable<? extends ProgressPromise<TResolve,TProgress>,Void> onFulfilledOrRejected)

Ensures that onFulfilledOrRejected will be called regardless of whether this promise is fulfilled or rejected. onFulfilledOrRejected WILL NOT receive the promises' value or reason. Any returned value will be disregarded. onFulfilledOrRejected may throw or return a rejected promise to signal an additional error.

Parameters:

onFulfilledOrRejected - handler to be called regardless of fulfillment or rejection

Returns:

a new promise

done

public WhenProgress.TrustedPromise done(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> handleResult,
                               Runnable<? extends ProgressPromise<TResolve,TProgress>,Value<TResolve>> handleError)

Terminate a promise chain by handling the ultimate fulfillment value or rejection reason, and assuming responsibility for all errors. if an error propagates out of handleResult or handleFatalError, it will be rethrown to the host, resulting in a loud stack track on most platforms and a crash on some.

Parameters:

handleResult - callback for successful completion

handleError - callback for rejected completion

Returns:

a new promise

yield

public ProgressPromise<TResolve,TProgress> yield(TResolve value)

Shortcut for .then(function() { return resolve(value); })

Specified by:

yield in interface PromiseExt<TResolve,TProgress>

Parameters:

value - the value to be returned

Returns:

an already-fulfilled ProgressPromise

yield

public WhenProgress.TrustedPromise yield(Thenable<TResolve,TProgress> value)

Shortcut for .then(function() { return value; })

Specified by:

yield in interface PromiseExt<TResolve,TProgress>

Parameters:

value - the Thenable to yield

Returns:

a promise that: - is fulfilled if value is not a promise, or - if value is a promise, will fulfill with its value, or reject with its reason.

tap

public WhenProgress.TrustedPromise tap(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilledSideEffect)

Runs a side effect when this promise fulfills, without changing the fulfillment value.

Parameters:

{function} - onFulfilledSideEffect

always

public ProgressPromise<TResolve,TProgress> always(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilledOrRejected)

Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected)

Specified by:

always in interface PromiseExt<TResolve,TProgress>

Parameters:

onFulfilledOrRejected - a callback for when a promise is fulfilled or rejected

Returns:

a new ProgressPromise

always

public WhenProgress.TrustedPromise always(Runnable<? extends ProgressPromise<TResolve,TProgress>,TResolve> onFulfilledOrRejected,
                                 Runnable<Value<TProgress>,Value<TProgress>> onProgress)

Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected)

Specified by:

always in interface PromiseExt<TResolve,TProgress>

Parameters:

onFulfilledOrRejected - a callback for when a promise is fulfilled or rejected

onProgress - a callback for progress notifications

Returns:

a new ProgressPromise