net.lecousin.framework.concurrent.async

Class AsyncSupplier<T,TError extends Exception>

java.lang.Object

net.lecousin.framework.concurrent.async.AsyncSupplier<T,TError>

Type Parameters:

T - type of result

TError - type of error

All Implemented Interfaces:

Future<T>, Cancellable, IAsync<TError>

Direct Known Subclasses:

Task.Output

public class AsyncSupplier<T,TError extends Exception>
extends Object
implements IAsync<TError>, Future<T>

Same as a SynchronizationPoint, except that it contains a result.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AsyncSupplier.Listener<T,TError extends Exception> Listener with one method by possible state.

Constructor Summary

Constructors

Constructor and Description
AsyncSupplier() Constructor.
AsyncSupplier(T result, TError error) Create an unblocked point with the given result and error.
AsyncSupplier(T result, TError error, CancelException cancel) Create an unblocked point with the given result, error and cancellation.

Method Summary

Modifier and Type	Method and Description
void	block(long timeout) Pause the current thread to wait for this asynchronous unit to be unblocked.
boolean	blockPauseCondition() Return true if blockPause should still block.
T	blockResult(long timeout) Block until this AsyncSupplier is unblocked or the given timeout expired, and return the result in case of success, or throw the error or cancellation.
boolean	cancel(boolean mayInterruptIfRunning)
void	cancel(CancelException reason) Cancel this object: unblock it immediately, and set the cancellation reason.
<TError2 extends Exception> AsyncSupplier<T,TError2>	convertError(Function<TError,TError2> converter) Create an AsyncSupplier from the given one, adapting the error.
void	error(TError error) Unblock with an error.
void	forward(AsyncSupplier<T,TError> sp) Forward the result, error, or cancellation to the given AsyncSupplier.
<TError2 extends Exception> void	forward(AsyncSupplier<T,TError2> sp, Function<TError,TError2> errorConverter) Forward the result, error, or cancellation to the given AsyncSupplier.
T	get()
T	get(long timeout, TimeUnit unit)
Collection<?>	getAllListeners() Return a collection with all listeners, only for debugging purposes.
CancelException	getCancelEvent() Get the reason of the cancellation.
TError	getError() Return the error.
T	getResult()
boolean	hasError() Return true if unblocked because of an error.
boolean	isCancelled() Return true if this object is cancelled.
boolean	isDone() Return true if unblocked (success or cancelled).
void	listen(AsyncSupplier.Listener<T,TError> listener) Add a listener to be called when this AsyncSupplier is unblocked.
void	onDone(Async<TError> sp) Transfer the result of this asynchronous unit to the given one: unblock it on success, call error method on error, or call cancel method on cancellation.
void	onDone(Consumer<T> onready) Call one of the given listener on success.
void	onDone(Consumer<T> onready, Consumer<TError> onerror, Consumer<CancelException> oncancel) Call one of the given listener depending on result.
void	onDone(Consumer<T> onready, IAsync<TError> onErrorAndCancel) Call onready on success, or forward error/cancellation to onErrorAndCancel.
<TError2 extends Exception> void	onDone(Consumer<T> onready, IAsync<TError2> onErrorAndCancel, Function<TError,TError2> errorConverter) Call onready on success, or forward error/cancellation to onErrorAndCancel.
void	onDone(Runnable r) Call listener when unblocked (whatever the result is successful, has error or is cancelled).
void	onDone(Runnable onready, IAsync<TError> onErrorAndCancel) Call listener when unblocked, or forward error/cancellation to onErrorOrCancel.
void	reset() Reset this AsyncSupplier point to reuse it.
boolean	thenDoOrStart(Consumer<T> consumer, String taskDescription, byte taskPriority) Call consumer immediately (in current thread) if done, or start a CPU task on done.
boolean	thenDoOrStart(Consumer<T> consumer, String taskDescription, byte taskPriority, IAsync<TError> onErrorOrCancel) Call consumer immediately (in current thread) if done, or start a CPU task on done.
<T2> AsyncSupplier<T2,TError>	thenStart(Task.Parameter<T,T2,TError> task, boolean evenIfErrorOrCancel) Start the given task when this asynchronous unit is unblocked.
void	unblockCancel(CancelException event) Cancel this AsyncSupplier.
void	unblockError(TError error) Unblock this AsyncSupplier with an error.
void	unblockSuccess(T result) Unblock this AsyncSupplier with the given result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.concurrent.async.IAsync

blockException, blockPause, blockThrow, forwardIfNotSuccessful, isSuccessful, logListenerError, onCancel, onDone, onDone, onDone, onDone, onError, onErrorOrCancel, onSuccess, thenDoOrStart, thenDoOrStart, thenDoOrStart, thenStart, thenStart, thenStart, thenStart, thenStart, thenStart, toAsyncSupplier

Constructor Detail

AsyncSupplier

public AsyncSupplier()

Constructor.

AsyncSupplier

public AsyncSupplier(T result,
                     TError error)

Create an unblocked point with the given result and error.

AsyncSupplier

public AsyncSupplier(T result,
                     TError error,
                     CancelException cancel)

Create an unblocked point with the given result, error and cancellation.

Method Detail

getResult

public final T getResult()

getError

public final TError getError()

Description copied from interface: IAsync

Return the error.

Specified by:

getError in interface IAsync<TError extends Exception>

getCancelEvent

public final CancelException getCancelEvent()

Description copied from interface: Cancellable

Get the reason of the cancellation.

Specified by:

getCancelEvent in interface Cancellable

isCancelled

public final boolean isCancelled()

Description copied from interface: Cancellable

Return true if this object is cancelled.

Specified by:

isCancelled in interface Future<T>

Specified by:

isCancelled in interface Cancellable

hasError

public final boolean hasError()

Description copied from interface: IAsync

Return true if unblocked because of an error.

Specified by:

hasError in interface IAsync<TError extends Exception>

getAllListeners

public Collection<?> getAllListeners()

Description copied from interface: IAsync

Return a collection with all listeners, only for debugging purposes.

Specified by:

getAllListeners in interface IAsync<TError extends Exception>

listen

public final void listen(AsyncSupplier.Listener<T,TError> listener)

Add a listener to be called when this AsyncSupplier is unblocked.

forward

public final void forward(AsyncSupplier<T,TError> sp)

Forward the result, error, or cancellation to the given AsyncSupplier.

forward

public final <TError2 extends Exception> void forward(AsyncSupplier<T,TError2> sp,
                                                      Function<TError,TError2> errorConverter)

Forward the result, error, or cancellation to the given AsyncSupplier.

onDone

public final void onDone(Runnable r)

Description copied from interface: IAsync

Call listener when unblocked (whatever the result is successful, has error or is cancelled).

Specified by:

onDone in interface IAsync<TError extends Exception>

onDone

public final void onDone(Async<TError> sp)

Description copied from interface: IAsync

Transfer the result of this asynchronous unit to the given one: unblock it on success, call error method on error, or call cancel method on cancellation.

Specified by:

onDone in interface IAsync<TError extends Exception>

onDone

public final void onDone(Consumer<T> onready,
                         Consumer<TError> onerror,
                         Consumer<CancelException> oncancel)

Call one of the given listener depending on result.

onDone

public final void onDone(Consumer<T> onready)

Call one of the given listener on success.

onDone

public final void onDone(Consumer<T> onready,
                         IAsync<TError> onErrorAndCancel)

Call onready on success, or forward error/cancellation to onErrorAndCancel.

onDone

public final void onDone(Runnable onready,
                         IAsync<TError> onErrorAndCancel)

Description copied from interface: IAsync

Call listener when unblocked, or forward error/cancellation to onErrorOrCancel.

Specified by:

onDone in interface IAsync<TError extends Exception>

onDone

public final <TError2 extends Exception> void onDone(Consumer<T> onready,
                                                     IAsync<TError2> onErrorAndCancel,
                                                     Function<TError,TError2> errorConverter)

Call onready on success, or forward error/cancellation to onErrorAndCancel.

convertError

public final <TError2 extends Exception> AsyncSupplier<T,TError2> convertError(Function<TError,TError2> converter)

Create an AsyncSupplier from the given one, adapting the error.

thenStart

public <T2> AsyncSupplier<T2,TError> thenStart(Task.Parameter<T,T2,TError> task,
                                               boolean evenIfErrorOrCancel)

Start the given task when this asynchronous unit is unblocked.

thenDoOrStart

public boolean thenDoOrStart(Consumer<T> consumer,
                             String taskDescription,
                             byte taskPriority)

Call consumer immediately (in current thread) if done, or start a CPU task on done.

thenDoOrStart

public boolean thenDoOrStart(Consumer<T> consumer,
                             String taskDescription,
                             byte taskPriority,
                             IAsync<TError> onErrorOrCancel)

Call consumer immediately (in current thread) if done, or start a CPU task on done.

unblockSuccess

public final void unblockSuccess(T result)

Unblock this AsyncSupplier with the given result.

unblockError

public final void unblockError(TError error)

Unblock this AsyncSupplier with an error. Equivalent to the method error.

error

public final void error(TError error)

Description copied from interface: IAsync

Unblock with an error.

Specified by:

error in interface IAsync<TError extends Exception>

unblockCancel

public void unblockCancel(CancelException event)

Cancel this AsyncSupplier. Equivalent to the method cancel.

cancel

public final void cancel(CancelException reason)

Description copied from interface: Cancellable

Cancel this object: unblock it immediately, and set the cancellation reason.

Specified by:

cancel in interface Cancellable

block

public final void block(long timeout)

Description copied from interface: IAsync

Pause the current thread to wait for this asynchronous unit to be unblocked.

Specified by:

block in interface IAsync<TError extends Exception>

blockResult

public final T blockResult(long timeout)
                    throws TError extends Exception,
                           CancelException

Block until this AsyncSupplier is unblocked or the given timeout expired, and return the result in case of success, or throw the error or cancellation.

Parameters:

timeout - in milliseconds. 0 or negative value means infinite.

Throws:

TError extends Exception

CancelException

blockPauseCondition

public boolean blockPauseCondition()

Description copied from interface: IAsync

Return true if blockPause should still block.

Specified by:

blockPauseCondition in interface IAsync<TError extends Exception>

isDone

public final boolean isDone()

Description copied from interface: IAsync

Return true if unblocked (success or cancelled).

Specified by:

isDone in interface Future<T>

Specified by:

isDone in interface IAsync<TError extends Exception>

reset

public final void reset()

Reset this AsyncSupplier point to reuse it. This method remove any previous result, error or cancellation, and mark this AsyncSupplier as blocked. Any previous listener is also removed.

get

public final T get()
            throws InterruptedException,
                   ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

get

public final T get(long timeout,
                   TimeUnit unit)
            throws InterruptedException,
                   ExecutionException,
                   TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>