com.github.bordertech.taskmaster

Interface TaskMasterProvider

All Known Implementing Classes:

TaskMasterProviderExecutorService

public interface TaskMasterProvider

TaskMasterProvider helps projects run ASYNC tasks.

Since:

1.0.0

Author:

Jonathan Austin

Method Summary

Modifier and Type	Method and Description
void	shutdown() Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
void	shutdownNow() Attempts to stop all actively executing tasks, halts the processing of waiting tasks.
<T> TaskFuture<T>	submit(Runnable task, T result) Submits a Runnable task for execution and returns a Future representing that task.
<T> TaskFuture<T>	submit(Runnable task, T result, String pool) Submits a Runnable task for execution and returns a Future representing that task.

Method Detail

shutdown

void shutdown()

Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.

Throws:

SecurityException - if a security manager exists and shutting down this ExecutorService may manipulate threads that the caller is not permitted to modify because it does not hold permission

shutdownNow

void shutdownNow()

Attempts to stop all actively executing tasks, halts the processing of waiting tasks.

Throws:

SecurityException - if a security manager exists and shutting down this ExecutorService may manipulate threads that the caller is not permitted to modify because it does not hold permission

submit

<T> TaskFuture<T> submit(Runnable task,
                         T result)
                  throws RejectedTaskException

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.

Uses the default thread pool.

Type Parameters:

T - the type for the future

Parameters:

task - the task to submit

result - the result to return

Returns:

a Future representing pending completion of the task

Throws:

RejectedTaskException - if the task cannot be scheduled for execution

submit

<T> TaskFuture<T> submit(Runnable task,
                         T result,
                         String pool)
                  throws RejectedTaskException

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 for the future

Parameters:

task - the task to submit

result - the result to return

pool - the thread pool name, or null if no pool

Returns:

a Future representing pending completion of the task

Throws:

RejectedTaskException - if the task cannot be scheduled for execution