io.machinecode.then.api

Interface Progress<T,F,P,Tx,Fx,Px>

public interface Progress<T,F,P,Tx,Fx,Px>

Interceptor allowing modification of chained Promise's.

Since:

1.0

Author:

Brent Douglas

Method Summary

Modifier and Type	Method and Description
void	progress(P that, Deferred<Tx,Fx,Px> next) Allows modifying the new promises backing Deferred when the original promise recieves a message via Deferred.progress(Object).
void	reject(F that, Deferred<Tx,Fx,Px> next) The caller SHOULD ensure that one of Deferred.resolve(Object), Deferred.reject(Object) or Promise.cancel(boolean) is called on the Deferred parameter.
void	resolve(T that, Deferred<Tx,Fx,Px> next) The caller SHOULD ensure that one of Deferred.resolve(Object), Deferred.reject(Object) or Promise.cancel(boolean) is called on the Deferred parameter.

Method Detail

resolve

void resolve(T that,
             Deferred<Tx,Fx,Px> next)

The caller SHOULD ensure that one of Deferred.resolve(Object), Deferred.reject(Object) or Promise.cancel(boolean) is called on the Deferred parameter.

Parameters:

that - The resolved value of the original Promise.

next - A Deferred that controls the state of the returned promise.

See Also:

Promise.then(Progress), Deferred.resolve(Object)

reject

void reject(F that,
            Deferred<Tx,Fx,Px> next)

The caller SHOULD ensure that one of Deferred.resolve(Object), Deferred.reject(Object) or Promise.cancel(boolean) is called on the Deferred parameter.

Parameters:

that - The rejected value of the original Promise.

next - A Deferred that controls the state of the returned promise.

See Also:

Promise.then(Progress), Deferred.reject(Object)

progress

void progress(P that,
              Deferred<Tx,Fx,Px> next)

Allows modifying the new promises backing Deferred when the original promise recieves a message via Deferred.progress(Object). The caller MAY use this method to call one of Deferred.resolve(Object), Deferred.reject(Object) or Promise.cancel(boolean) on the Deferred parameter.

Parameters:

that - The progress message from the original Promise

next - A Deferred that controls the state of the returned promise.

See Also:

Promise.then(Progress), Deferred.progress(Object)