org.waarp.common.future

Class WaarpCompletedFuture

java.lang.Object

org.waarp.common.future.WaarpFuture

org.waarp.common.future.WaarpCompletedFuture

Direct Known Subclasses:

WaarpFailedFuture, WaarpSucceededFuture

public abstract class WaarpCompletedFuture
extends WaarpFuture

Future completed

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WaarpCompletedFuture()

Method Summary

Modifier and Type	Method and Description
boolean	awaitOrInterruptible()
boolean	awaitOrInterruptible(long timeoutMilliseconds)
boolean	awaitOrInterruptible(long timeout, TimeUnit unit)
boolean	cancel() Cancels the operation associated with this future and notifies all listeners if canceled successfully.
boolean	isCancelled() Returns true if and only if this future was canceled by a WaarpFuture.cancel() method.
boolean	isDone() Returns true if and only if this future is complete, regardless of whether the operation was successful, failed, or canceled.
void	reset() Experimental: try to re-enable the future
boolean	setFailure(Throwable cause) Marks this future as a failure and notifies all listeners.
boolean	setSuccess() Marks this future as a success and notifies all listeners.

Methods inherited from class org.waarp.common.future.WaarpFuture

getCause, isFailed, isSuccess, rethrowIfFailed

Methods inherited from class java.lang.Object

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

Constructor Detail

WaarpCompletedFuture

protected WaarpCompletedFuture()

Method Detail

awaitOrInterruptible

public boolean awaitOrInterruptible()

Overrides:

awaitOrInterruptible in class WaarpFuture

Returns:

True if the Future is done or False if interrupted

awaitOrInterruptible

public boolean awaitOrInterruptible(long timeoutMilliseconds)

Overrides:

awaitOrInterruptible in class WaarpFuture

Returns:

True if the Future is done or False if interrupted

awaitOrInterruptible

public boolean awaitOrInterruptible(long timeout,
                                    TimeUnit unit)

Overrides:

awaitOrInterruptible in class WaarpFuture

Returns:

True if the Future is done or False if interrupted

reset

public void reset()

Description copied from class: WaarpFuture

Experimental: try to re-enable the future

Overrides:

reset in class WaarpFuture

isDone

public boolean isDone()

Description copied from class: WaarpFuture

Returns true if and only if this future is complete, regardless of whether the operation was successful, failed, or canceled.

Overrides:

isDone in class WaarpFuture

Returns:

True if the future is complete

setFailure

public boolean setFailure(Throwable cause)

Description copied from class: WaarpFuture

Marks this future as a failure and notifies all listeners.

Overrides:

setFailure in class WaarpFuture

Returns:

true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

setSuccess

public boolean setSuccess()

Description copied from class: WaarpFuture

Marks this future as a success and notifies all listeners.

Overrides:

setSuccess in class WaarpFuture

Returns:

true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

cancel

public boolean cancel()

Description copied from class: WaarpFuture

Cancels the operation associated with this future and notifies all listeners if canceled successfully.

Overrides:

cancel in class WaarpFuture

Returns:

true if and only if the operation has been canceled. false if the operation can't be canceled or is already completed.

isCancelled

public boolean isCancelled()

Description copied from class: WaarpFuture

Returns true if and only if this future was canceled by a WaarpFuture.cancel() method.

Overrides:

isCancelled in class WaarpFuture

Returns:

True if the future was canceled