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

Author:

Frederic Bregier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WaarpCompletedFuture()

Method Summary

Methods

Modifier and Type	Method and Description
WaarpFuture	await() Waits for this future to be completed.
boolean	await(long timeoutMillis) Waits for this future to be completed within the specified time limit.
boolean	await(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit.
WaarpFuture	awaitUninterruptibly() Waits for this future to be completed without interruption.
boolean	awaitUninterruptibly(long timeoutMillis) Waits for this future to be completed within the specified time limit without interruption.
boolean	awaitUninterruptibly(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit without interruption.
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.
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, reset, 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

await

public WaarpFuture await()
                  throws InterruptedException

Description copied from class: WaarpFuture

Waits for this future to be completed.

Overrides:

await in class WaarpFuture

Returns:

The WaarpFuture

Throws:

InterruptedException - if the current thread was interrupted

await

public boolean await(long timeout,
            TimeUnit unit)
              throws InterruptedException

Description copied from class: WaarpFuture

Waits for this future to be completed within the specified time limit.

Overrides:

await in class WaarpFuture

Returns:

true if and only if the future was completed within the specified time limit

Throws:

InterruptedException - if the current thread was interrupted

await

public boolean await(long timeoutMillis)
              throws InterruptedException

Description copied from class: WaarpFuture

Waits for this future to be completed within the specified time limit.

Overrides:

await in class WaarpFuture

Returns:

true if and only if the future was completed within the specified time limit

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public WaarpFuture awaitUninterruptibly()

Description copied from class: WaarpFuture

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

Overrides:

awaitUninterruptibly in class WaarpFuture

Returns:

The WaarpFuture

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
                           TimeUnit unit)

Description copied from class: WaarpFuture

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Overrides:

awaitUninterruptibly in class WaarpFuture

Returns:

true if and only if the future was completed within the specified time limit

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Description copied from class: WaarpFuture

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Overrides:

awaitUninterruptibly in class WaarpFuture

Returns:

true if and only if the future was completed within the specified time limit

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