org.eclipse.equinox.concurrent.future

Class ImmediateExecutor

java.lang.Object

org.eclipse.equinox.concurrent.future.AbstractExecutor

org.eclipse.equinox.concurrent.future.ImmediateExecutor

All Implemented Interfaces:

IExecutor, IRunnableExecutor

public class ImmediateExecutor
extends AbstractExecutor
implements IExecutor, IRunnableExecutor

Executes IProgressRunnable instances immediately.

NOTE: execute(IProgressRunnable, IProgressMonitor) should be used with some degree of caution with this implementation, as unlike other implementations the IProgressRunnable.run(IProgressMonitor) method will be called by the thread that calls execute(IProgressRunnable, IProgressMonitor), meaning that calling #execute(IProgressRunnable, IProgressMonitor) may block the calling thread indefinitely.

Since:

1.1

See Also:

ThreadsExecutor

Constructor Summary

Constructors

Constructor and Description
ImmediateExecutor()

Method Summary

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

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

execute

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.IRunnableExecutor

execute

Constructor Detail

ImmediateExecutor

public ImmediateExecutor()

Method Detail

createFuture

protected AbstractFuture<?> createFuture(IProgressMonitor monitor)

Description copied from class: AbstractExecutor

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

Specified by:

createFuture in class AbstractExecutor

Parameters:

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

Returns:

the created future

execute

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

Specified by:

execute in class AbstractExecutor

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.