Package cn.sliew.milky.concurrent

Interface Future<V>

All Superinterfaces:

Future

All Known Subinterfaces:

ProgressiveFuture<V>, ProgressivePromise<V>, Promise<V>

All Known Implementing Classes:

AbstractFuture, CompleteFuture, DefaultProgressivePromise, DefaultPromise, FailedFuture, SucceededFuture

public interface Future<V>
extends Future

The result of an asynchronous operation.

Method Summary

Modifier and Type	Method	Description
Future<V>	addListener(FutureListener<? extends Future<? super V>> listener)	Adds the specified listener to this future.
Future<V>	await()	Waits for this future to be completed.
boolean	await(long timeout, TimeUnit unit)	Waits for this future to be completed within the specified time limit.
Throwable	cause()	Returns the cause of the failed operation if the operation has failed.
V	getNow()	Return the result without blocking.
boolean	isSuccess()	Returns true if and only if the operation was completed successfully.
Future<V>	removeListener(FutureListener<? extends Future<? super V>> listener)	Removes the first occurrence of the specified listener from this future.
Future<V>	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

isSuccess

boolean isSuccess()

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

cause

Throwable cause()

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.

addListener

Future<V> addListener(FutureListener<? extends Future<? super V>> listener)

Adds the specified listener to this future. The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.

removeListener

Future<V> removeListener(FutureListener<? extends Future<? super V>> listener)

Removes the first occurrence of the specified listener from this future. The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.

sync

Future<V> sync()
        throws InterruptedException

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Throws:

InterruptedException

await

Future<V> await()
         throws InterruptedException

Waits for this future to be completed.

Throws:

InterruptedException - if the current thread was interrupted

await

boolean await(long timeout,
              TimeUnit unit)
       throws InterruptedException

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

Returns:

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

Throws:

InterruptedException - if the current thread was interrupted

getNow

V getNow()

Return the result without blocking. If the future is not done yet this will return null.

As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not relay on the returned null value.