org.stjs.bridge.rsvp

Class Deferred<Result,FailResponse>

java.lang.Object

org.stjs.bridge.rsvp.Deferred<Result,FailResponse>

public final class Deferred<Result,FailResponse>
extends Object

Sometimes one needs to create a deferred object, without immediately specifying how it will be resolved. These deferred objects are essentially a wrapper around a promise, whilst providing late access to the resolve() and reject() methods.

 Deferred<String, Error> deferred = RSVP.defer();
 // ...
 deferred.promise // access the promise
 // ...
 deferred.resolve("Hello");
 

The RSVP.Promise constructor is generally a better, less error-prone choice than RSVP.defer(). Promises are recommended unless the specific properties of deferred are needed.

Field Summary

Fields

Modifier and Type	Field and Description
Promise<Result,FailResponse>	promise Returns the promise that is wrapped by this Deferred object.

Method Summary

Methods

Modifier and Type	Method and Description
void	reject(FailResponse failValue) Rejects this Deferred's underlying promise, passing the specified value to the reject handler of all thenables chained to the promise
void	resolve(Result value) Resolves this Deferred's underlying promise, passing the specified value to all then thenables chained to the promise

Methods inherited from class java.lang.Object

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

Field Detail

promise

public Promise<Result,FailResponse> promise

Returns the promise that is wrapped by this Deferred object. Deferred objects are not promise instances and you can therefore not call any of the flavors of then() on them directly. You can do so using the promise field.

Method Detail

resolve

public void resolve(Result value)

Resolves this Deferred's underlying promise, passing the specified value to all then thenables chained to the promise

Parameters:

value - the value to be propagated to all chained thenables

reject

public void reject(FailResponse failValue)

Rejects this Deferred's underlying promise, passing the specified value to the reject handler of all thenables chained to the promise

Parameters:

failValue - the value to be propagated to the reject handlers of all chained thenables