com.alee.managers.task

Class TaskGroup

java.lang.Object

com.alee.managers.task.TaskGroup

All Implemented Interfaces:

Identifiable

public class TaskGroup
extends Object
implements Identifiable

This manager provides API for convenient usage of Thread groups. You can register and shutdown TaskGroups within TaskManager at will.

Author:

Vyacheslav Ivanov, Mikle Garin

See Also:

How to use ConcurrencyManager, TaskManager

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	executorService ExecutorService used for executing tasks.
protected String	id This TaskGroup identifier.
protected int	maxThreadsCount Maximum parallel Threads count in this TaskGroup.
protected ThreadFactory	threadFactory ThreadFactory used to spawn Threads for executing tasks.

Constructor Summary

Constructors

Constructor and Description
TaskGroup(String id) Constructs new TaskGroup.
TaskGroup(String id, int maxThreadsCount) Constructs new TaskGroup.
TaskGroup(String id, ThreadFactory threadFactory) Constructs new TaskGroup.
TaskGroup(String id, ThreadFactory threadFactory, int maxThreadsCount) Constructs new TaskGroup.

Method Summary

Modifier and Type	Method and Description
<V> Future<V>	execute(Callable<V> callable) Executes specified Callable.
Future<?>	execute(Runnable runnable) Executes specified Runnable.
protected ExecutorService	executorService() Returns ExecutorService that can be used to execute tasks according to this TaskGroup settings.
String	getId() Returns unique object identifier.
int	hashCode()
void	shutdown() Shutdowns this TaskGroup after finishing all remaining submitted tasks.
void	shutdownNow() Shutdowns this TaskGroup without finishing any of remaining submitted tasks.

Methods inherited from class java.lang.Object

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

Field Detail

id

@NotNull
protected final String id

This TaskGroup identifier.

threadFactory

@NotNull
protected final ThreadFactory threadFactory

ThreadFactory used to spawn Threads for executing tasks.

maxThreadsCount

protected final int maxThreadsCount

Maximum parallel Threads count in this TaskGroup.

executorService

@Nullable
protected ExecutorService executorService

ExecutorService used for executing tasks.

Constructor Detail

TaskGroup

public TaskGroup(@NotNull
                 String id)

Constructs new TaskGroup.

Parameters:

id - this TaskGroup identifier

TaskGroup

public TaskGroup(@NotNull
                 String id,
                 int maxThreadsCount)

Constructs new TaskGroup.

Parameters:

id - this TaskGroup identifier

maxThreadsCount - maximum parallel Threads count in this TaskGroup

TaskGroup

public TaskGroup(@NotNull
                 String id,
                 @NotNull
                 ThreadFactory threadFactory)

Constructs new TaskGroup.

Parameters:

id - this TaskGroup identifier

threadFactory - ThreadFactory used to spawn Threads for executing tasks

TaskGroup

public TaskGroup(@NotNull
                 String id,
                 @NotNull
                 ThreadFactory threadFactory,
                 int maxThreadsCount)

Constructs new TaskGroup.

Parameters:

id - this TaskGroup identifier

threadFactory - ThreadFactory used to spawn Threads for executing tasks

maxThreadsCount - maximum parallel Threads count in this TaskGroup

Method Detail

getId

@NotNull
public String getId()

Description copied from interface: Identifiable

Returns unique object identifier. todo Probably change back to NotNull in future

Specified by:

getId in interface Identifiable

Returns:

unique object identifier

execute

@NotNull
public Future<?> execute(@NotNull
                                  Runnable runnable)

Executes specified Runnable. Returns Future of the execured task.

Parameters:

runnable - Runnable to execute

Returns:

Future of the execured task

execute

@NotNull
public <V> Future<V> execute(@NotNull
                                      Callable<V> callable)

Executes specified Callable. Returns Future of the execured task.

Type Parameters:

V - computed result type

Parameters:

callable - Callable to execute

Returns:

Future of the execured task

shutdown

public void shutdown()

Shutdowns this TaskGroup after finishing all remaining submitted tasks.

shutdownNow

public void shutdownNow()

Shutdowns this TaskGroup without finishing any of remaining submitted tasks.

executorService

@NotNull
protected ExecutorService executorService()

Returns ExecutorService that can be used to execute tasks according to this TaskGroup settings. In case ExecutorService doesn't exist or was shutdown it will be recreated.

Returns:

ExecutorService that can be used to execute tasks according to this TaskGroup settings

hashCode

public int hashCode()

Overrides:

hashCode in class Object