FutureImpl (async-net 1.0.3 API)

java.lang.Object
- me.melchor9000.net.FutureImpl<ReturnType>

All Implemented Interfaces:: Future<ReturnType>

public class FutureImpl<ReturnType>
extends java.lang.Object
implements Future<ReturnType>

My implementation of the Future

Constructor Summary

Constructors
Constructor and Description

FutureImpl(IOService service, Procedure whenCancelled)

Constructors
Constructor and Description
`FutureImpl(IOService service, Procedure whenCancelled)`

Method Summary

All Methods Instance Methods Concrete 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.
`void`	`postError(java.lang.Throwable cause)`
`void`	`postSuccess(ReturnType result)`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FutureImpl
```
public FutureImpl(IOService service,
                  Procedure whenCancelled)
```
- Method Detail
  - isDone
```
public boolean isDone()
```
    Description copied from interface: Future
    
    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.
    
    Specified by:
    
    isDone in interface Future<ReturnType>
    
    Returns:
    
    true if the task is done
  - isSuccessful
```
public boolean isSuccessful()
```
    Description copied from interface: Future
    
    Returns true when the task is done and was not cancelled nor any error was raised.
    
    Specified by:
    
    isSuccessful in interface Future<ReturnType>
    
    Returns:
    
    true if the task is completed successfully
  - isCancelled
```
public boolean isCancelled()
```
    Description copied from interface: Future
    
    Returns true when the task is done and was cancelled.
    
    Specified by:
    
    isCancelled in interface Future<ReturnType>
    
    Returns:
    
    true if the task was cancelled
  - isCancelable
```
public boolean isCancelable()
```
    Description copied from interface: Future
    
    Returns true if the task can be cancelled and it is able to set a timeout
    
    Specified by:
    
    isCancelable in interface Future<ReturnType>
    
    Returns:
    
    true if cancellable
  - cancel
```
public void cancel(boolean mayInterrupt)
```
    Description copied from interface: Future
    
    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.
    
    Specified by:
    
    cancel in interface Future<ReturnType>
    
    Parameters:
    
    mayInterrupt - indicates if may interrupt the execution
  - whenDone
```
public Future<ReturnType> whenDone(Callback<Future<ReturnType>> cbk)
```
    Description copied from interface: Future
    
    Calls the Callback when the task is done. If the task is done, the callback is called directly. The callback cannot be null.
    
    Specified by:
    
    whenDone in interface Future<ReturnType>
    
    Parameters:
    
    cbk - callback
    
    Returns:
    
    this same Future
  - setTimeout
```
public Future<ReturnType> setTimeout(long milliseconds)
```
    Description copied from interface: Future
    
    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.
    
    Specified by:
    
    setTimeout in interface Future<ReturnType>
    
    Parameters:
    
    milliseconds - time to timeout the task
    
    Returns:
    
    this same Future
  - getValueNow
```
public ReturnType getValueNow()
```
    Description copied from interface: Future
    
    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 Future.isDone() to determine if the task is done.
    
    Specified by:
    
    getValueNow in interface Future<ReturnType>
    
    Returns:
    
    the returned value when done and successful
  - cause
```
public java.lang.Throwable cause()
```
    Description copied from interface: Future
    
    If the task is done and is not successful, then this method gets the cause of the failure. In other cases, returns null.
    
    Specified by:
    
    cause in interface Future<ReturnType>
    
    Returns:
    
    a Throwable cause of the failure of the task
  - getValue
```
public ReturnType getValue(long millis)
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException,
                           java.util.concurrent.TimeoutException
```
    Description copied from interface: Future
    
    Waits at most millis milliseconds for the ending of the task.
    
    Specified by:
    
    getValue in interface Future<ReturnType>
    
    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
  - getValueUninterrumptibly
```
public ReturnType getValueUninterrumptibly(long millis)
                                    throws java.util.concurrent.ExecutionException,
                                           java.util.concurrent.TimeoutException
```
    Description copied from interface: Future
    
    Waits at most millis milliseconds for the ending of the task. If this Thread is interrupted, silently will catch the exception and continue waiting.
    
    Specified by:
    
    getValueUninterrumptibly in interface Future<ReturnType>
    
    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
  - getValue
```
public ReturnType getValue()
                    throws java.util.concurrent.ExecutionException,
                           java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits until the task is done.
    
    Specified by:
    
    getValue in interface Future<ReturnType>
    
    Returns:
    
    the returned value
    
    Throws:
    
    java.util.concurrent.ExecutionException - if the computation threw an exception
    
    java.lang.InterruptedException - if the current thread was interrupted while waiting
  - getValueUninterrumptibly
```
public ReturnType getValueUninterrumptibly()
                                    throws java.util.concurrent.ExecutionException,
                                           java.lang.InterruptedException
```
    Description copied from interface: Future
    
    Waits until the task is done, ignoring interruptions.
    
    Specified by:
    
    getValueUninterrumptibly in interface Future<ReturnType>
    
    Returns:
    
    the returned value
    
    Throws:
    
    java.util.concurrent.ExecutionException - if the computation threw an exception
    
    java.lang.InterruptedException - if the current thread was interrupted while waiting
  - sync
```
public Future<ReturnType> sync()
```
    Description copied from interface: Future
    
    Waits until the end of the task. If the task fails, rethrows the cause of the failure.
    
    Specified by:
    
    sync in interface Future<ReturnType>
    
    Returns:
    
    this same Future
  - postSuccess
```
public void postSuccess(ReturnType result)
```
  - postError
```
public void postError(java.lang.Throwable cause)
```

Class FutureImpl<ReturnType>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FutureImpl

Method Detail

isDone

isSuccessful

isCancelled

isCancelable

cancel

whenDone

setTimeout

getValueNow

cause

getValue

getValueUninterrumptibly

getValue

getValueUninterrumptibly

sync

postSuccess

postError