Package org.jdeferred2
Interface Deferred<D,F,P>
-
- Type Parameters:
D
- Type used forresolve(Object)
F
- Type used forreject(Object)
P
- Type used fornotify(Object)
- All Superinterfaces:
Promise<D,F,P>
- All Known Implementing Classes:
AbstractMasterDeferredObject
,AllValuesDeferredObject
,DeferredObject
,FilteredPromise
,MasterDeferredObject2
,MasterDeferredObject3
,MasterDeferredObject4
,MasterDeferredObject5
,MasterDeferredObjectN
,MasterDeferredObjectUntypedN
,PipedPromise
,SingleDeferredObject
public interface Deferred<D,F,P> extends Promise<D,F,P>
Deferred interface to trigger an event (resolve, reject, notify). Subsequently, this will allow Promise observers to listen in on the event (done, fail, progress).- See Also:
DeferredObject
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.jdeferred2.Promise
Promise.State
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Deferred<D,F,P>
notify(P progress)
This should be called when a task is still executing and progress had been made, E.g., during a file download, notify the download progress.Promise<D,F,P>
promise()
Return anPromise
instance (i.e., an observer).Deferred<D,F,P>
reject(F reject)
This should be called when a task has completed unsuccessfully, i.e., a failure may have occurred.Deferred<D,F,P>
resolve(D resolve)
This should be called when a task has completed successfully.-
Methods inherited from interface org.jdeferred2.Promise
always, done, fail, filter, filter, filter, isPending, isRejected, isResolved, pipe, pipe, pipe, pipeAlways, progress, state, then, then, then, waitSafely, waitSafely
-
-
-
-
Method Detail
-
resolve
Deferred<D,F,P> resolve(D resolve)
This should be called when a task has completed successfully.Deferred
deferredObject = newDeferredObject
();Promise
promise = deferredObject.promise(); promise.done(newDoneCallback
() { public void onDone(Object result) { // Done! } }); // another thread using the same deferredObject deferredObject.resolve("OK");- Parameters:
resolve
- the resolved value for thisDeferred
- Returns:
- the reference to this
Deferred
instance.
-
reject
Deferred<D,F,P> reject(F reject)
This should be called when a task has completed unsuccessfully, i.e., a failure may have occurred.Deferred
deferredObject = newDeferredObject
();Promise
promise = deferredObject.promise(); promise.fail(newFailCallback
() { public void onFail(Object result) { // Failed :( } }); // another thread using the same deferredObject deferredObject.reject("BAD");- Parameters:
reject
- the rejected value for thisDeferred
- Returns:
- the reference to this
Deferred
instance.
-
notify
Deferred<D,F,P> notify(P progress)
This should be called when a task is still executing and progress had been made, E.g., during a file download, notify the download progress.Deferred
deferredObject = newDeferredObject
();Promise
promise = deferredObject.promise(); promise.progress(newProgressCallback
() { public void onProgress(Object progress) { // Failed :( } }); // another thread using the same deferredObject deferredObject.reject("100%");- Parameters:
progress
- the intermediate result for thisDeferred
- Returns:
- the reference to this
Deferred
instance.
-
-