net.lecousin.framework.concurrent.async

Class Async<TError extends Exception>

java.lang.Object

net.lecousin.framework.concurrent.async.Async<TError>

Type Parameters:

TError - type of exception it may raise

All Implemented Interfaces:

Future<Void>, Cancellable, IAsync<TError>

Direct Known Subclasses:

JoinPoint

public class Async<TError extends Exception>
extends Object
implements IAsync<TError>, Future<Void>

Simplest implementation of a synchronization point.

Constructor Summary

Constructors

Constructor and Description
Async() Constructor.
Async(boolean unblocked) Constructor with an initial state.
Async(CancelException cancel) Create an unblocked point with a cancellation.
Async(IAsync<TError2> toConvert, Function<TError2,TError> errorConverter) Create an asynchronous unit from the given one, converting the error using the given converter.
Async(TError error) Create an unblocked point with an error.

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.
boolean	cancel(boolean mayInterruptIfRunning)
void	cancel(CancelException reason) Cancel this object: unblock it immediately, and set the cancellation reason.
void	error(TError error) Unblock with an error.
Void	get()
Void	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.
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	onDone(Runnable r) Call listener when unblocked (whatever the result is successful, has error or is cancelled).
void	reset() Reset this synchronization point to reuse it.
void	restart() Same as the method reset except that listeners are kept.
void	unblock() Unblock this synchronization point without error.

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, onDone, onDone, onError, onErrorOrCancel, onSuccess, thenDoOrStart, thenDoOrStart, thenDoOrStart, thenStart, thenStart, thenStart, thenStart, thenStart, thenStart, toAsyncSupplier

Constructor Detail

Async

public Async()

Constructor.

Async

public Async(boolean unblocked)

Constructor with an initial state.

Async

public Async(TError error)

Create an unblocked point with an error.

Async

public Async(CancelException cancel)

Create an unblocked point with a cancellation.

Async

public Async(IAsync<TError2> toConvert,
             Function<TError2,TError> errorConverter)

Create an asynchronous unit from the given one, converting the error using the given converter.

Method Detail

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>

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>

unblock

public final void unblock()

Unblock this synchronization point without 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>

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>

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<Void>

Specified by:

isDone in interface IAsync<TError extends Exception>

isCancelled

public final boolean isCancelled()

Description copied from interface: Cancellable

Return true if this object is cancelled.

Specified by:

isCancelled in interface Future<Void>

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>

getCancelEvent

public final CancelException getCancelEvent()

Description copied from interface: Cancellable

Get the reason of the cancellation.

Specified by:

getCancelEvent in interface Cancellable

getError

public final TError getError()

Description copied from interface: IAsync

Return the error.

Specified by:

getError in interface IAsync<TError extends Exception>

reset

public final void reset()

Reset this synchronization point to reuse it. This method remove any previous error or cancellation and mark this synchronization point as blocked. Any previous listener is also removed, and won't be called.

restart

public final void restart()

Same as the method reset except that listeners are kept.

get

public final Void get()
               throws InterruptedException,
                      ExecutionException

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

get

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

Specified by:

get in interface Future<Void>

Throws:

InterruptedException

ExecutionException

TimeoutException

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Void>