Future (async-net 1.0.3 API)

All Known Implementing Classes:

FutureImpl
```
public interface Future<ReturnType>
```
About the result of an asynchronous task.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cancel(boolean mayInterrupt)` Attempts to cancel the task.
`java.lang.Throwable`	`cause()` If the task is done and is not successful, then this method gets the cause of the failure.
`ReturnType`	`getValue()` Waits until the task is done.
`ReturnType`	`getValue(long millis)` Waits at most `millis` milliseconds for the ending of the task.
`ReturnType`	`getValueNow()` Returns the value of the future if it is done.
`ReturnType`	`getValueUninterrumptibly()` Waits until the task is done, ignoring interruptions.
`ReturnType`	`getValueUninterrumptibly(long millis)` Waits at most `millis` milliseconds for the ending of the task.
`boolean`	`isCancelable()` Returns true if the task can be cancelled and it is able to set a timeout
`boolean`	`isCancelled()` Returns true when the task is done and was cancelled.
`boolean`	`isDone()` Returns true when the task is completed, false otherwise.
`boolean`	`isSuccessful()` Returns true when the task is done and was not cancelled nor any error was raised.
`Future<ReturnType>`	`setTimeout(long milliseconds)` When set to a positive value (0 not included), will set a timeout, starting the instant of type that this method was called, until the `milliseconds`.
`Future<ReturnType>`	`sync()` Waits until the end of the task.
`Future<ReturnType>`	`whenDone(Callback<Future<ReturnType>> cbk)` Calls the `Callback` when the task is done.

- Method Detail
  - isDone
```
boolean isDone()
```
    Returns true when the task is completed, false otherwise. Completion only refers to the end of the task, if the task was cancelled, and error was thrown or it's successful, this method will return true.
    
    Returns:
    
    true if the task is done
  - isSuccessful
```
boolean isSuccessful()
```
    Returns true when the task is done and was not cancelled nor any error was raised.
    
    Returns:
    
    true if the task is completed successfully
  - isCancelled
```
boolean isCancelled()
```
    Returns true when the task is done and was cancelled.
    
    Returns:
    
    true if the task was cancelled
  - isCancelable
```
boolean isCancelable()
```
    Returns true if the task can be cancelled and it is able to set a timeout
    
    Returns:
    
    true if cancellable
  - cancel
```
void cancel(boolean mayInterrupt)
```
    Attempts to cancel the task. If it is running the task, with mayInterrupt will also interrupt the execution. If the task is done, the attempt will fail.
    When cancelled, the cause will be an CancellationException.
    
    Parameters:
    
    mayInterrupt - indicates if may interrupt the execution
  - whenDone
```
Future<ReturnType> whenDone(Callback<Future<ReturnType>> cbk)
```
    Calls the Callback when the task is done. If the task is done, the callback is called directly. The callback cannot be null.
    
    Parameters:
    
    cbk - callback
    
    Returns:
    
    this same Future
  - setTimeout
```
Future<ReturnType> setTimeout(long milliseconds)
```
    When set to a positive value (0 not included), will set a timeout, starting the instant of type that this method was called, until the milliseconds. When the timeout is fired and the Future is not done, will cancel the task.
    Call this method when a timeout is already set, will replace the timeout for a new one.
    
    If the task is not cancelable or is done, this method will fail and throw an IllegalStateException.
    
    Parameters:
    
    milliseconds - time to timeout the task
    
    Returns:
    
    this same Future
  - getValueNow
```
ReturnType getValueNow()
```
    Returns the value of the future if it is done. If not, then returns null. Beware that null can also be returned by the task, check isDone() to determine if the task is done.
    
    Returns:
    
    the returned value when done and successful
  - cause
```
java.lang.Throwable cause()
```
    If the task is done and is not successful, then this method gets the cause of the failure. In other cases, returns null.
    
    Returns:
    
    a Throwable cause of the failure of the task
  - getValue
```
ReturnType getValue(long millis)
             throws java.lang.InterruptedException,
                    java.util.concurrent.ExecutionException,
                    java.util.concurrent.TimeoutException
```
    Waits at most millis milliseconds for the ending of the task.
    
    Parameters:
    
    millis - time in milliseconds to wait
    
    Returns:
    
    the returned value
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted while waiting
    
    java.util.concurrent.ExecutionException - if the computation threw an exception
    
    java.util.concurrent.TimeoutException - if the wait timed out
    
    java.util.concurrent.CancellationException - if the computation was cancelled
  - getValueUninterrumptibly
```
ReturnType getValueUninterrumptibly(long millis)
                             throws java.util.concurrent.ExecutionException,
                                    java.util.concurrent.TimeoutException
```
    Waits at most millis milliseconds for the ending of the task. If this Thread is interrupted, silently will catch the exception and continue waiting.
    
    Parameters:
    
    millis - time to wait in milliseconds
    
    Returns:
    
    the returned value
    
    Throws:
    
    java.util.concurrent.ExecutionException - if the computation threw an exception
    
    java.util.concurrent.TimeoutException - if the wait timed out
    
    java.util.concurrent.CancellationException - if the computation was cancelled
  - getValue
```
ReturnType getValue()
             throws java.util.concurrent.ExecutionException,
                    java.lang.InterruptedException
```
    Waits until the task is done.
    
    Returns:
    
    the returned value
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted while waiting
    
    java.util.concurrent.ExecutionException - if the computation threw an exception
    
    java.util.concurrent.CancellationException - if the computation was cancelled
  - getValueUninterrumptibly
```
ReturnType getValueUninterrumptibly()
                             throws java.util.concurrent.ExecutionException,
                                    java.lang.InterruptedException
```
    Waits until the task is done, ignoring interruptions.
    
    Returns:
    
    the returned value
    
    Throws:
    
    java.lang.InterruptedException - if the current thread was interrupted while waiting
    
    java.util.concurrent.ExecutionException - if the computation threw an exception
    
    java.util.concurrent.CancellationException - if the computation was cancelled
  - sync
```
Future<ReturnType> sync()
```
    Waits until the end of the task. If the task fails, rethrows the cause of the failure.
    
    Returns:
    
    this same Future

Interface Future<ReturnType>

Method Summary

Method Detail

isDone

isSuccessful

isCancelled

isCancelable

cancel

whenDone

setTimeout

getValueNow

cause

getValue

getValueUninterrumptibly

getValue

getValueUninterrumptibly

sync