Package cn.sliew.milky.concurrent

Interface ProgressivePromise<V>

All Superinterfaces:

Future<V>, Future, ProgressiveFuture<V>, Promise<V>

All Known Implementing Classes:

DefaultProgressivePromise

public interface ProgressivePromise<V>
extends Promise<V>, ProgressiveFuture<V>

Special ProgressiveFuture which is writable.

Method Summary

Modifier and Type	Method	Description
ProgressivePromise<V>	addListener(FutureListener<? extends Future<? super V>> listener)	Adds the specified listener to this future.
ProgressivePromise<V>	await()	Waits for this future to be completed.
ProgressivePromise<V>	removeListener(FutureListener<? extends Future<? super V>> listener)	Removes the first occurrence of the specified listener from this future.
ProgressivePromise<V>	setFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
ProgressivePromise<V>	setProgress(long progress, long total)	Sets the current progress of the operation and notifies the listeners that implement ProgressiveFutureListener.
ProgressivePromise<V>	setSuccess(V result)	Marks this future as a success and notifies all listeners.
ProgressivePromise<V>	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
boolean	tryProgress(long progress, long total)	Tries to set the current progress of the operation and notifies the listeners that implement ProgressiveFutureListener.

Methods inherited from interface cn.sliew.milky.concurrent.Future

await, cause, getNow, isSuccess

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Methods inherited from interface cn.sliew.milky.concurrent.Promise

tryFailure, trySuccess

Method Detail

setProgress

ProgressivePromise<V> setProgress(long progress,
                                  long total)

Sets the current progress of the operation and notifies the listeners that implement ProgressiveFutureListener.

tryProgress

boolean tryProgress(long progress,
                    long total)

Tries to set the current progress of the operation and notifies the listeners that implement ProgressiveFutureListener. If the operation is already complete or the progress is out of range, this method does nothing but returning false.

setSuccess

ProgressivePromise<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>

setFailure

ProgressivePromise<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>

addListener

ProgressivePromise<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 ProgressiveFuture<V>

Specified by:

addListener in interface Promise<V>

removeListener

ProgressivePromise<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 ProgressiveFuture<V>

Specified by:

removeListener in interface Promise<V>

sync

ProgressivePromise<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 ProgressiveFuture<V>

Specified by:

sync in interface Promise<V>

Throws:

InterruptedException

await

ProgressivePromise<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 ProgressiveFuture<V>

Specified by:

await in interface Promise<V>

Throws:

InterruptedException - if the current thread was interrupted