com.xdev.util.concurrent

Interface XdevExecutorService

All Superinterfaces:

Executor

All Known Implementing Classes:

XdevExecutorService.Implementation

public interface XdevExecutorService
extends Executor

An Executor that provides methods to manage termination and methods that can produce a Future for tracking progress of one or more asynchronous tasks.

Method submit extends base method Executor.execute(Runnable) by creating and returning a Future that can be used to cancel execution and/or wait for completion. Methods invokeAny and invokeAll perform the most commonly useful forms of bulk execution, executing a collection of tasks and then waiting for at least one, or all, to complete.

The instantiation and the shutdown process is handled by the framework. To use the executor just call one of the static get methods.

Since:

3.0

Author:

XDEV Software

See Also:

Application.getExecutorService()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	XdevExecutorService.Factory
static class	XdevExecutorService.Implementation Default implementation of the XdevExecutorService contract.

Field Summary

Fields

Modifier and Type	Field and Description
static String	GRACEFUL_SHUTDOWN_INIT_PARAMETER
static String	THREAD_COUNT_INIT_PARAMETER

Method Summary

Modifier and Type	Method and Description
void	shutdown() Initiates a shutdown of the executor service.
<T> Future<T>	submit(Callable<T> task) Submits a value-returning task for execution and returns a Future representing the pending results of the task.
Future<?>	submit(Runnable task) Submits a Runnable task for execution and returns a Future representing that task.
<T> Future<T>	submit(Runnable task, T result) Submits a Runnable task for execution and returns a Future representing that task.

Methods inherited from interface java.util.concurrent.Executor

execute

Field Detail

THREAD_COUNT_INIT_PARAMETER

static final String THREAD_COUNT_INIT_PARAMETER

See Also:

Constant Field Values

GRACEFUL_SHUTDOWN_INIT_PARAMETER

static final String GRACEFUL_SHUTDOWN_INIT_PARAMETER

See Also:

Constant Field Values

Method Detail

submit

Future<?> submit(Runnable task)

Submits a Runnable task for execution and returns a Future representing that task. The Future's get method will return null upon successful completion.

Parameters:

task - the task to submit

Returns:

a Future representing pending completion of the task

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

NullPointerException - if the task is null

submit

<T> Future<T> submit(Runnable task,
                     T result)

Submits a Runnable task for execution and returns a Future representing that task. The Future's get method will return the given result upon successful completion.

Type Parameters:

T - the type of the result

Parameters:

task - the task to submit

result - the result to return

Returns:

a Future representing pending completion of the task

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

NullPointerException - if the task is null

submit

<T> Future<T> submit(Callable<T> task)

Submits a value-returning task for execution and returns a Future representing the pending results of the task. The Future's get method will return the task's result upon successful completion.

If you would like to immediately block waiting for a task, you can use constructions of the form result = exec.submit(aCallable).get();

Type Parameters:

T - the type of the task's result

Parameters:

task - the task to submit

Returns:

a Future representing pending completion of the task

Throws:

RejectedExecutionException - if the task cannot be scheduled for execution

NullPointerException - if the task is null

shutdown

void shutdown()

Initiates a shutdown of the executor service. This is done automatically when the corresponding servlet context is destroyed and therefor shouldn't be called by the user.