org.eclipse.equinox.concurrent.future

Class ThreadsExecutor

java.lang.Object

org.eclipse.equinox.concurrent.future.AbstractExecutor

org.eclipse.equinox.concurrent.future.ThreadsExecutor

All Implemented Interfaces:

IExecutor, IRunnableExecutor

public class ThreadsExecutor
extends AbstractExecutor

An executor that implements running the givenIProgressRunnables via a new Thread.

The execute(IProgressRunnable, IProgressMonitor) method on this class will create a new Thread (with name provided as result of createThreadName(IProgressRunnable), that will run the IProgressRunnable and set the result in the future returned from execute(IProgressRunnable, IProgressMonitor).

Subclasses may extend the behavior of this ThreadsExecutor.

Since:

1.1

Constructor Summary

Constructors

Constructor and Description
ThreadsExecutor()

Method Summary

Modifier and Type	Method and Description
protected void	configureThreadForExecution(java.lang.Thread thread) Configure the given thread prior to starting it.
protected AbstractFuture<?>	createFuture(IProgressMonitor monitor) Create an AbstractFuture with the given IProgressMonitor.
protected java.lang.Runnable	createRunnable(ISafeProgressRunner runner, IProgressRunnable<?> progressRunnable) Create a runnable given an IProgressRunnable and an ISafeProgressRunner to run the runnable.
protected java.lang.String	createThreadName(IProgressRunnable<?> runnable)
<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

Constructor Detail

ThreadsExecutor

public ThreadsExecutor()

Method Detail

createThreadName

protected java.lang.String createThreadName(IProgressRunnable<?> runnable)

createRunnable

protected java.lang.Runnable createRunnable(ISafeProgressRunner runner,
                                            IProgressRunnable<?> progressRunnable)

Create a runnable given an IProgressRunnable and an ISafeProgressRunner to run the runnable.

Parameters:

runner - the safe progress runner to run the runnable

progressRunnable - the runnable to run.

Returns:

Runnable that when run will use the safe progress runner to run the progressRunnable

configureThreadForExecution

protected void configureThreadForExecution(java.lang.Thread thread)

Configure the given thread prior to starting it. Subclasses may override as appropriate to configure the given thread appropriately. The default implementation calls Thread.setDaemon(boolean).

Parameters:

thread - the thread to configure

createFuture

protected AbstractFuture<?> createFuture(IProgressMonitor monitor)

Create an AbstractFuture with the given IProgressMonitor.

Specified by:

createFuture in class AbstractExecutor

Parameters:

monitor - a progress monitor to associate with the future. May be null.

Returns:

the created future

execute

public <ResultType> IFuture<ResultType> execute(IProgressRunnable<? extends ResultType> runnable,
                                                IProgressMonitor monitor)
                                         throws java.lang.IllegalThreadStateException

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.

Throws:

java.lang.IllegalThreadStateException