org.waarp.common.future

Class WaarpFuture

java.lang.Object

org.waarp.common.future.WaarpFuture

All Implemented Interfaces:

WaarpFutureInterface

Direct Known Subclasses:

R66Future, RestFuture, WaarpChannelFuture

public class WaarpFuture
extends Object
implements WaarpFutureInterface

Ftp Future operation
Completely inspired from the excellent ChannelFuture of Netty, but without any channel inside.

Constructor Summary

Constructors

Constructor and Description
WaarpFuture() Creates a new instance.
WaarpFuture(boolean cancellable) Creates a new instance.

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.
Throwable	getCause() Returns the cause of the failed operation if the operation has failed.
boolean	isCancelled() Returns true if and only if this future was canceled by a 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	isFailed() Returns true if and only if the operation was completed but unsuccessfully.
boolean	isSuccess() Returns true if and only if the operation was completed successfully.
void	reset() Experimental: try to re-enable the future
WaarpFuture	rethrowIfFailed() Rethrows the exception that caused this future fail if this future is complete and failed.
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 java.lang.Object

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

Constructor Detail

WaarpFuture

public WaarpFuture()

Creates a new instance.

WaarpFuture

public WaarpFuture(boolean cancellable)

Creates a new instance.

Parameters:

cancellable - true if and only if this future can be canceled

Method Detail

isDone

public final boolean isDone()

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

Specified by:

isDone in interface WaarpFutureInterface

Returns:

True if the future is complete

isSuccess

public final boolean isSuccess()

Returns true if and only if the operation was completed successfully.

Specified by:

isSuccess in interface WaarpFutureInterface

Returns:

True if the future is successful

isFailed

public final boolean isFailed()

Returns true if and only if the operation was completed but unsuccessfully.

Specified by:

isFailed in interface WaarpFutureInterface

Returns:

True if the future is done but unsuccessful

getCause

public final Throwable getCause()

Returns the cause of the failed operation if the operation has failed.

Specified by:

getCause in interface WaarpFutureInterface

Returns:

the cause of the failure. null if succeeded or this future is not completed yet.

isCancelled

public final boolean isCancelled()

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

Specified by:

isCancelled in interface WaarpFutureInterface

Returns:

True if the future was canceled

rethrowIfFailed

public final WaarpFuture rethrowIfFailed()
                                  throws Exception

Rethrows the exception that caused this future fail if this future is complete and failed.

Specified by:

rethrowIfFailed in interface WaarpFutureInterface

Throws:

Exception

awaitOrInterruptible

public final boolean awaitOrInterruptible()

Specified by:

awaitOrInterruptible in interface WaarpFutureInterface

Returns:

True if the Future is done or False if interrupted

awaitOrInterruptible

public final boolean awaitOrInterruptible(long timeoutMilliseconds)

Specified by:

awaitOrInterruptible in interface WaarpFutureInterface

Parameters:

timeoutMilliseconds -

Returns:

True if the Future is done or False if interrupted

awaitOrInterruptible

public final boolean awaitOrInterruptible(long timeout,
                                          TimeUnit unit)

Specified by:

awaitOrInterruptible in interface WaarpFutureInterface

Parameters:

timeout -

unit -

Returns:

True if the Future is done or False if interrupted

setSuccess

public final boolean setSuccess()

Marks this future as a success and notifies all listeners.

Specified by:

setSuccess in interface WaarpFutureInterface

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.

setFailure

public final boolean setFailure(Throwable cause)

Marks this future as a failure and notifies all listeners.

Specified by:

setFailure in interface WaarpFutureInterface

Parameters:

cause -

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.

cancel

public final boolean cancel()

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

Specified by:

cancel in interface WaarpFutureInterface

Returns:

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

reset

public final void reset()

Experimental: try to re-enable the future

Specified by:

reset in interface WaarpFutureInterface