WaarpFuture (Waarp Common 3.3.4 API Reference)

java.lang.Object
- org.waarp.common.future.WaarpFuture

Direct Known Subclasses:

R66Future, RestFuture, WaarpChannelFuture, WaarpCompletedFuture
```
public class WaarpFuture
extends Object
```
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.

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

Method Summary

All Methods Instance Methods Concrete Methods
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 boolean isDone()
```
    Returns true if and only if this future is complete, regardless of whether the operation was successful, failed, or canceled.
    
    Returns:
    
    True if the future is complete
  - isSuccess
```
public boolean isSuccess()
```
    Returns true if and only if the operation was completed successfully.
    
    Returns:
    
    True if the future is successful
  - isFailed
```
public boolean isFailed()
```
    Returns true if and only if the operation was completed but unsuccessfully.
    
    Returns:
    
    True if the future is done but unsuccessful
  - getCause
```
public Throwable getCause()
```
    Returns the cause of the failed operation if the operation has failed.
    
    Returns:
    
    the cause of the failure. null if succeeded or this future is not completed yet.
  - isCancelled
```
public boolean isCancelled()
```
    Returns true if and only if this future was canceled by a cancel() method.
    
    Returns:
    
    True if the future was canceled
  - rethrowIfFailed
```
public WaarpFuture rethrowIfFailed()
                            throws Exception
```
    Rethrows the exception that caused this future fail if this future is complete and failed.
    
    Throws:
    
    Exception
  - awaitOrInterruptible
```
public boolean awaitOrInterruptible()
```
    Returns:
    
    True if the Future is done or False if interrupted
  - awaitOrInterruptible
```
public boolean awaitOrInterruptible(long timeoutMilliseconds)
```
    Parameters:
    
    timeoutMilliseconds -
    
    Returns:
    
    True if the Future is done or False if interrupted
  - awaitOrInterruptible
```
public boolean awaitOrInterruptible(long timeout,
                                    TimeUnit unit)
```
    Parameters:
    
    timeout -
    
    unit -
    
    Returns:
    
    True if the Future is done or False if interrupted
  - setSuccess
```
public boolean setSuccess()
```
    Marks this future as a success and notifies all listeners.
    
    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 boolean setFailure(Throwable cause)
```
    Marks this future as a failure and notifies all listeners.
    
    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 boolean cancel()
```
    Cancels the operation associated with this future and notifies all listeners if canceled successfully.
    
    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 void reset()
```
    Experimental: try to re-enable the future

Class WaarpFuture

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WaarpFuture

WaarpFuture

Method Detail

isDone

isSuccess

isFailed

getCause

isCancelled

rethrowIfFailed

awaitOrInterruptible

awaitOrInterruptible

awaitOrInterruptible

setSuccess

setFailure

cancel

reset