net.lecousin.framework.concurrent.async

Class AbstractLock<TError extends Exception>

java.lang.Object

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

Type Parameters:

TError - type of exception

All Implemented Interfaces:

Cancellable, IAsync<TError>

Direct Known Subclasses:

LockPoint, MutualExclusion, WaitingDataQueueSynchronizationPoint

public abstract class AbstractLock<TError extends Exception>
extends Object
implements IAsync<TError>

Base class for locks.

Field Summary

Fields

Modifier and Type	Field and Description
protected CancelException	cancel
protected TError	error
protected ArrayList<Runnable>	listeners

Constructor Summary

Constructors

Constructor and Description
AbstractLock()

Method Summary

Modifier and Type	Method and Description
void	cancel(CancelException reason) Cancel this object: unblock it immediately, and set the cancellation reason.
void	error(TError error) Unblock with an error.
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.
protected abstract void	unlock()

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

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

Field Detail

error

protected TError extends Exception error

cancel

protected CancelException cancel

listeners

protected ArrayList<Runnable> listeners

Constructor Detail

AbstractLock

public AbstractLock()

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>

unlock

protected abstract void unlock()

isCancelled

public final boolean isCancelled()

Description copied from interface: Cancellable

Return true if this object is cancelled.

Specified by:

isCancelled in interface Cancellable

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

getCancelEvent

public final CancelException getCancelEvent()

Description copied from interface: Cancellable

Get the reason of the cancellation.

Specified by:

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

getError

public final TError getError()

Description copied from interface: IAsync

Return the error.

Specified by:

getError in interface IAsync<TError extends Exception>

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>