Package cn.sliew.milky.concurrent

Class DefaultPromise<V>

java.lang.Object

cn.sliew.milky.concurrent.AbstractFuture<V>

cn.sliew.milky.concurrent.DefaultPromise<V>

All Implemented Interfaces:

Future<V>, Promise<V>, Future

Direct Known Subclasses:

DefaultProgressivePromise

public class DefaultPromise<V>
extends AbstractFuture<V>
implements Promise<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected List<FutureListener<? extends Future<? super V>>>	listeners	One or more listeners.

Constructor Summary

Constructors

Constructor	Description
DefaultPromise()

Method Summary

Modifier and Type	Method	Description
Promise<V>	addListener(FutureListener<? extends Future<? super V>> listener)	Adds the specified listener to this future.
Promise<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.
boolean	cancel(boolean mayInterruptIfRunning)
Throwable	cause()	Returns the cause of the failed operation if the operation has failed.
V	getNow()	Return the result without blocking.
boolean	isCancelled()
boolean	isDone()
boolean	isSuccess()	Returns true if and only if the operation was completed successfully.
Promise<V>	removeListener(FutureListener<? extends Future<? super V>> listener)	Removes the first occurrence of the specified listener from this future.
Promise<V>	setFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
Promise<V>	setSuccess(V result)	Marks this future as a success and notifies all listeners.
Promise<V>	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
boolean	tryFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
boolean	trySuccess(V result)	Marks this future as a success and notifies all listeners.

Methods inherited from class cn.sliew.milky.concurrent.AbstractFuture

get, get

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Future

get, get

Field Detail

listeners

protected List<FutureListener<? extends Future<? super V>>> listeners

One or more listeners.

Constructor Detail

DefaultPromise

public DefaultPromise()

Method Detail

setSuccess

public Promise<V> setSuccess(V result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners.

If it is success or failed already it will throw an IllegalStateException.

Specified by:

setSuccess in interface Promise<V>

trySuccess

public boolean trySuccess(V result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners.

Specified by:

trySuccess in interface Promise<V>

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 Promise<V> setFailure(Throwable cause)

Description copied from interface: Promise

Marks this future as a failure and notifies all listeners.

If it is success or failed already it will throw an IllegalStateException.

Specified by:

setFailure in interface Promise<V>

tryFailure

public boolean tryFailure(Throwable cause)

Description copied from interface: Promise

Marks this future as a failure and notifies all listeners.

Specified by:

tryFailure in interface Promise<V>

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.

addListener

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

Description copied from interface: Future

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.

Specified by:

addListener in interface Future<V>

Specified by:

addListener in interface Promise<V>

removeListener

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

Description copied from interface: Future

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.

Specified by:

removeListener in interface Future<V>

Specified by:

removeListener in interface Promise<V>

sync

public Promise<V> sync()
                throws InterruptedException

Description copied from interface: Future

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

Specified by:

sync in interface Future<V>

Specified by:

sync in interface Promise<V>

Throws:

InterruptedException

await

public Promise<V> await()
                 throws InterruptedException

Description copied from interface: Future

Waits for this future to be completed.

Specified by:

await in interface Future<V>

Specified by:

await in interface Promise<V>

Throws:

InterruptedException - if the current thread was interrupted

await

public boolean await(long timeout,
                     TimeUnit unit)
              throws InterruptedException

Description copied from interface: Future

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

Specified by:

await in interface Future<V>

Returns:

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

Throws:

InterruptedException - if the current thread was interrupted

isSuccess

public boolean isSuccess()

Description copied from interface: Future

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

Specified by:

isSuccess in interface Future<V>

cause

public Throwable cause()

Description copied from interface: Future

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

Specified by:

cause in interface Future<V>

Returns:

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

getNow

public V getNow()

Description copied from interface: Future

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.

Specified by:

getNow in interface Future<V>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<V>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<V>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<V>