Package cn.dinodev.spring.commons.promise

Interface Deferred<D>

Type Parameters:

D - Type used for resolved value

All Superinterfaces:

Promise<D>, Supplier<D>

All Known Implementing Classes:

DeferredObject

public interface Deferred<D>
extends Promise<D>

Deferred interface to trigger an event (resolve, reject, notify). Subsequently, this will allow Promise observers to listen in on the event (done, fail, progress).

Author:

Ray Tsang

See Also:

• DeferredObject

Nested Class Summary

Nested classes/interfaces inherited from interface cn.dinodev.spring.commons.promise.Promise

Promise.State

Method Summary

Modifier and Type	Method	Description
Promise<D>	promise()	Return an Promise instance (i.e., an observer).
<F extends Throwable> Deferred<D>	reject(F reject)	This should be called when a task has completed unsuccessfully, i.e., a failure may have occurred.
Deferred<D>	resolve(D resolve)	This should be called when a task has completed successfully.

Methods inherited from interface cn.dinodev.spring.commons.promise.Promise

always, done, fail, getOrElse, getOrElse, isPending, isRejected, isResolved, state, then, then, waitSafely, waitSafely

Methods inherited from interface java.util.function.Supplier

get

Method Details

resolve

Deferred<D> resolve(D resolve)

This should be called when a task has completed successfully.

 
 Deferred deferredObject = new DeferredObject();
 Promise promise = deferredObject.promise();
 promise.done(result -> {
   // Done!
 });

 // another thread using the same deferredObject
 deferredObject.resolve("OK");

 
 

Parameters:

resolve - the resolved value for this Deferred

Returns:

the reference to this Deferred instance.

reject

<F extends Throwable> Deferred<D> reject(F reject)

This should be called when a task has completed unsuccessfully, i.e., a failure may have occurred.

 
 Deferred deferredObject = new DeferredObject();
 Promise promise = deferredObject.promise();
 promise.fail(error -> {
   // Failed :(
 });

 // another thread using the same deferredObject
 deferredObject.reject("BAD");

 
 

Type Parameters:

F - Type of the exception/error

Parameters:

reject - the rejected value for this Deferred

Returns:

the reference to this Deferred instance.

promise

Promise<D> promise()

Return an Promise instance (i.e., an observer). You can register callbacks in this observer.

Returns:

the reference to this Deferred instance as a Promise,