org.eclipse.equinox.concurrent.future

Class AbstractExecutor

java.lang.Object

org.eclipse.equinox.concurrent.future.AbstractExecutor

All Implemented Interfaces:

IExecutor, IRunnableExecutor

Direct Known Subclasses:

ImmediateExecutor, ThreadsExecutor

public abstract class AbstractExecutor
extends java.lang.Object
implements IRunnableExecutor, IExecutor

Abstract implementation of IExecutor and IRunnableExecutor.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
AbstractExecutor()

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractFuture<?>	createFuture(IProgressMonitor progressMonitor) Create an AbstractFuture instance.
abstract <ResultType> IFuture<ResultType>	execute(IProgressRunnable<? extends ResultType> runnable, IProgressMonitor monitor) Execute the given IProgressRunnable (i.e. call IProgressRunnable.run(IProgressMonitor).
void	execute(java.lang.Runnable runnable)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExecutor

public AbstractExecutor()

Method Detail

execute

public void execute(java.lang.Runnable runnable)

Specified by:

execute in interface IRunnableExecutor

execute

public abstract <ResultType> IFuture<ResultType> execute(IProgressRunnable<? extends ResultType> runnable,
                                                         IProgressMonitor monitor)

Description copied from interface: IExecutor

Execute the given IProgressRunnable (i.e. call IProgressRunnable.run(IProgressMonitor). Will return a non- null instance of IFuture that allows clients to inspect the state of the execution and retrieve any results via IFuture.get() or IFuture.get(long).

Note that implementers may decide whether to invoke IProgressRunnable.run(IProgressMonitor) asynchronously or synchronously, but since IProgressRunnables are frequently going to be longer-running operations, implementers should proceed carefully before implementing with synchronous (blocking) invocation. Implementers should typically implement via some non-blocking asynchronous invocation mechanism, e.g. Threads, Jobs, ThreadPools etc.

Specified by:

execute in interface IExecutor

Type Parameters:

ResultType - the type that will be returned by the IProgressRunnable as well as the returned IFuture

Parameters:

runnable - the IProgressRunnable to invoke. Must not be null.

monitor - any IProgressMonitor to be passed to the runnable. May be null.

Returns:

IFuture to allow for inspection of the state of the computation by clients, as well as access to any return values of IProgressRunnable.run(IProgressMonitor). Will not be null.

createFuture

protected abstract AbstractFuture<?> createFuture(IProgressMonitor progressMonitor)

Create an AbstractFuture instance. Subclasses must override to define the concrete type of future to return from execute(IProgressRunnable, IProgressMonitor).

Parameters:

progressMonitor - any progress monitor to provide to the future upon construction. May be null.

Returns:

the created future