com.alee.managers.task

Class TaskManager

java.lang.Object

com.alee.managers.task.TaskManager

public final class TaskManager
extends Object

This manager provides API for convenient usage of TaskGroups. You can register, reconfigure and shutdown separate TaskGroups. Usig TaskGroup identifier you can execute Runnable or Callable tasks.

Author:

Vyacheslav Ivanov, Mikle Garin

See Also:

How to use ConcurrencyManager, TaskGroup, TaskException

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPUTATION Identifier of predefined TaskGroup for computation requests.
static String	FILE_SYSTEM Identifier of predefined TaskGroup for file system requests.
static String	REMOTE_REQUEST Identifier of predefined TaskGroup for remote requests.

Constructor Summary

Constructors

Constructor and Description
TaskManager()

Method Summary

Modifier and Type	Method and Description
static void	configureGroup(TaskGroup group) Configures existing TaskGroup.
static <V> Future<V>	execute(String groupId, Callable<V> callable) Executes specified Callable on the TaskGroup with the specified identifier.
static Future<?>	execute(String groupId, Runnable runnable) Executes specified Runnable on the TaskGroup with the specified identifier.
static boolean	exists(String groupId) Returns whether or not TaskGroup with the specified identifier already exists.
static boolean	exists(TaskGroup group) Returns whether or not specified TaskGroup already exists.
static TaskGroup	getGroup(String groupId) Returns TaskGroup with the specified identifier.
static void	initialize() Initializes TaskManager settings.
static void	registerGroup(TaskGroup group) Registers new TaskGroup.
static void	shutdown(String groupId) Shutdowns TaskGroup with the specified identifier after finishing all remaining submitted tasks.
static void	shutdownNow(String groupId) Shutdowns TaskGroup with the specified identifier without finishing any of remaining submitted tasks.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_SYSTEM

public static final String FILE_SYSTEM

Identifier of predefined TaskGroup for file system requests. By default it uses maximum 4 threads and DaemonThreadFactory. It can be configured through providing new ThreadGroup with same identifier in configureGroup(TaskGroup).

See Also:

Constant Field Values

REMOTE_REQUEST

public static final String REMOTE_REQUEST

Identifier of predefined TaskGroup for remote requests. By default it uses maximum 4 threads and DaemonThreadFactory. It can be configured through providing new ThreadGroup with same identifier in configureGroup(TaskGroup).

See Also:

Constant Field Values

COMPUTATION

public static final String COMPUTATION

Identifier of predefined TaskGroup for computation requests. By default it uses maximum 8 threads and DaemonThreadFactory. It can be configured through providing new ThreadGroup with same identifier in configureGroup(TaskGroup).

See Also:

Constant Field Values

Constructor Detail

TaskManager

public TaskManager()

Method Detail

initialize

public static void initialize()

Initializes TaskManager settings.

exists

public static boolean exists(@NotNull
                             TaskGroup group)

Returns whether or not specified TaskGroup already exists.

Parameters:

group - TaskGroup to look for

Returns:

true if specified TaskGroup already exists, false otherwise

exists

public static boolean exists(@NotNull
                             String groupId)

Returns whether or not TaskGroup with the specified identifier already exists.

Parameters:

groupId - identifier of TaskGroup to look for

Returns:

true if TaskGroup with the specified identifier already exists, false otherwise

getGroup

@NotNull
public static TaskGroup getGroup(@NotNull
                                          String groupId)

Returns TaskGroup with the specified identifier. Throws TaskException if such TaskGroup is not yet registered.

Parameters:

groupId - identifier of TaskGroup to look for

Returns:

TaskGroup with the specified identifier

registerGroup

public static void registerGroup(@NotNull
                                 TaskGroup group)

Registers new TaskGroup. Throws TaskException if such TaskGroup was already registered.

Parameters:

group - TaskGroup to register

configureGroup

public static void configureGroup(@NotNull
                                  TaskGroup group)

Configures existing TaskGroup. Throws TaskException if such TaskGroup is not yet registered.

Parameters:

group - TaskGroup to configure

execute

@NotNull
public static Future<?> execute(@NotNull
                                         String groupId,
                                         @NotNull
                                         Runnable runnable)

Executes specified Runnable on the TaskGroup with the specified identifier. Returns Future of the execured task.

Parameters:

groupId - identifier of TaskGroup to execute Runnable on

runnable - Runnable to execute

Returns:

Future of the execured task

execute

@NotNull
public static <V> Future<V> execute(@NotNull
                                             String groupId,
                                             @NotNull
                                             Callable<V> callable)

Executes specified Callable on the TaskGroup with the specified identifier. Returns Future of the execured task.

Type Parameters:

V - computed result type

Parameters:

groupId - identifier of TaskGroup to execute Callable on

callable - Callable to execute

Returns:

Future of the execured task

shutdown

public static void shutdown(@NotNull
                            String groupId)

Shutdowns TaskGroup with the specified identifier after finishing all remaining submitted tasks.

Parameters:

groupId - identifier of TaskGroup to shutdown

shutdownNow

public static void shutdownNow(@NotNull
                               String groupId)

Shutdowns TaskGroup with the specified identifier without finishing any of remaining submitted tasks.

Parameters:

groupId - identifier of TaskGroup to shutdown