org.eclipse.equinox.concurrent.future

Class SingleOperationListenableFuture<ResultType>

java.lang.Object

org.eclipse.equinox.concurrent.future.AbstractFuture<ResultType>

org.eclipse.equinox.concurrent.future.SingleOperationFuture<ResultType>

org.eclipse.equinox.concurrent.future.SingleOperationListenableFuture<ResultType>

All Implemented Interfaces:

IFuture<ResultType>, IListenableFuture<ResultType>, ISafeProgressRunner

public class SingleOperationListenableFuture<ResultType>
extends SingleOperationFuture<ResultType>
implements IListenableFuture<ResultType>

Listenable future implementation for a single operation.

Subclasses may be created if desired. Note that if subclasses are created, that they should/must be very careful with respect to overriding the synchronized methods in this class.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
SingleOperationListenableFuture()
SingleOperationListenableFuture(IProgressMonitor progressMonitor)

Method Summary

Modifier and Type	Method and Description
void	addListener(IExecutor executor, IProgressRunnable<ResultType> progressRunnable, IProgressMonitor monitor) Add an IProgressRunnable that will be called back/run once the asynchronous execution is complete.
void	runWithProgress(IProgressRunnable<?> runnable) This method is not intended to be called by clients.

Methods inherited from class org.eclipse.equinox.concurrent.future.SingleOperationFuture

cancel, get, get, getProgressMonitor, getStatus, hasValue, isCanceled, isDone, set, setException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.equinox.concurrent.future.IFuture

cancel, get, get, getStatus, hasValue, isDone

Constructor Detail

SingleOperationListenableFuture

public SingleOperationListenableFuture()

SingleOperationListenableFuture

public SingleOperationListenableFuture(IProgressMonitor progressMonitor)

Method Detail

addListener

public void addListener(IExecutor executor,
                        IProgressRunnable<ResultType> progressRunnable,
                        IProgressMonitor monitor)

Description copied from interface: IListenableFuture

Add an IProgressRunnable that will be called back/run once the asynchronous execution is complete. The IProgressRunnable must be non-null and the IExecutor must also be non- null. The given progressMonitor may be null.

If the future has already completed by the time this method is called (i.e. IFuture.isDone() returns true, the progressRunnable will be executed immediately by the given executor.

Specified by:

addListener in interface IListenableFuture<ResultType>

Parameters:

executor - the IExecutor to use to execute the given IProgressRunnable. Must not be null.

progressRunnable - the IProgressRunnable that will be executed when this future is complete. Must not be null.

monitor - an optional progress monitor to be passed to the progressRunnable when executed. May be null.

runWithProgress

public void runWithProgress(IProgressRunnable<?> runnable)

Description copied from class: SingleOperationFuture

This method is not intended to be called by clients. Rather it should only be used by IExecutors.

Specified by:

runWithProgress in interface ISafeProgressRunner

Overrides:

runWithProgress in class SingleOperationFuture<ResultType>