Module jakarta.concurrency

Package jakarta.enterprise.concurrent

Class ManagedExecutors

java.lang.Object

jakarta.enterprise.concurrent.ManagedExecutors

public final class ManagedExecutors
extends java.lang.Object

Utility methods for classes defined in this package.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ManagedExecutors.Adapter
(package private) static class	ManagedExecutors.CallableAdapter<V>	Adapter for Callable to include ManagedTask interface methods.
(package private) static class	ManagedExecutors.RunnableAdapter	Adapter for Runnable to include ManagedTask interface methods.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	NULL_TASK_ERROR_MSG	Error message for null tasks.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ManagedExecutors()	Not suppose to create instances of this class.

Method Summary

Modifier and Type	Method	Description
static boolean	isCurrentThreadShutdown()	Utility method for checking the isShutdown() value of the current thread if it is a ManageableThread created from ManagedThreadFactory.newThread() .
static java.lang.Runnable	managedTask(java.lang.Runnable task, ManagedTaskListener taskListener)	Returns a Runnable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.
static java.lang.Runnable	managedTask(java.lang.Runnable task, java.util.Map<java.lang.String,java.lang.String> executionProperties, ManagedTaskListener taskListener)	Returns a Runnable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener and to provide additional execution properties when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.
static <V> java.util.concurrent.Callable<V>	managedTask(java.util.concurrent.Callable<V> task, ManagedTaskListener taskListener)	Returns a Callable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.
static <V> java.util.concurrent.Callable<V>	managedTask(java.util.concurrent.Callable<V> task, java.util.Map<java.lang.String,java.lang.String> executionProperties, ManagedTaskListener taskListener)	Returns a Callable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener and to provide additional execution properties when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.

Methods inherited from class java.lang.Object

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

Field Detail

NULL_TASK_ERROR_MSG

static final java.lang.String NULL_TASK_ERROR_MSG

Error message for null tasks.

See Also:

Constant Field Values

Constructor Detail

ManagedExecutors

private ManagedExecutors()

Not suppose to create instances of this class.

Method Detail

isCurrentThreadShutdown

public static boolean isCurrentThreadShutdown()

Utility method for checking the isShutdown() value of the current thread if it is a ManageableThread created from ManagedThreadFactory.newThread() .

Returns:

Returns the isShutdown() value if the current thread is a ManageableThread created by ManagedThreadFactory, or false if the current thread is not a ManageableThread.

managedTask

public static java.lang.Runnable managedTask(java.lang.Runnable task,
                                             ManagedTaskListener taskListener)
                                      throws java.lang.IllegalArgumentException

Returns a Runnable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.

Example:

 Runnable task = ...;
 ManagedTaskListener myTaskListener = ...;
 ManagedExecutorService executor = ...;

 Runnable taskWithListener = ManagedExecutors.managedTask(task, myTaskListener);
 executor.submit(taskWithListener);
 

Parameters:

task - the task to have the given ManagedTaskListener associated with

taskListener - (optional) the ManagedTaskListener to receive lifecycle events notification when the task is submitted. If task implements ManagedTask, and taskListener is not null, the ManagedTaskListener interface methods of the task will not be called.

Returns:

a Runnable object

Throws:

java.lang.IllegalArgumentException - if task is null

managedTask

public static java.lang.Runnable managedTask(java.lang.Runnable task,
                                             java.util.Map<java.lang.String,java.lang.String> executionProperties,
                                             ManagedTaskListener taskListener)
                                      throws java.lang.IllegalArgumentException

Returns a Runnable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener and to provide additional execution properties when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.

Parameters:

task - the task to have the given ManagedTaskListener associated with

taskListener - (optional) the ManagedTaskListener to receive lifecycle events notification when the task is submitted. If task implements ManagedTask, and taskListener is not null, the ManagedTaskListener interface methods of the task will not be called.

executionProperties - (optional) execution properties to provide additional hints to ManagedExecutorService or ManagedScheduledExecutorService when the task is submitted. If task implements ManagedTask with non-empty execution properties, the Runnable returned will contain the union of the execution properties specified in the task and the executionProperties argument, with the latter taking precedence if the same property key is specified in both. After the method is called, further changes to the Map object will not be reflected in the Runnable returned by this method.

Returns:

a Runnable object

Throws:

java.lang.IllegalArgumentException - if task is null

managedTask

public static <V> java.util.concurrent.Callable<V> managedTask(java.util.concurrent.Callable<V> task,
                                                               ManagedTaskListener taskListener)
                                                        throws java.lang.IllegalArgumentException

Returns a Callable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.

Type Parameters:

V - the return type of the Callable

Parameters:

task - the task to have the given ManagedTaskListener associated with

taskListener - (optional) the ManagedTaskListener to receive lifecycle events notification when the task is submitted. If task implements ManagedTask, and taskListener is not null, the ManagedTaskListener interface methods of the task will not be called.

Returns:

a Callable object

Throws:

java.lang.IllegalArgumentException - if task is null

managedTask

public static <V> java.util.concurrent.Callable<V> managedTask(java.util.concurrent.Callable<V> task,
                                                               java.util.Map<java.lang.String,java.lang.String> executionProperties,
                                                               ManagedTaskListener taskListener)
                                                        throws java.lang.IllegalArgumentException

Returns a Callable object that also implements ManagedTask interface so it can receive notification of lifecycle events with the provided ManagedTaskListener and to provide additional execution properties when the task is submitted to a ManagedExecutorService or a ManagedScheduledExecutorService.

Type Parameters:

V - the result type of the Callable

Parameters:

task - the task to have the given ManagedTaskListener associated with

taskListener - (optional) the ManagedTaskListener to receive lifecycle events notification when the task is submitted. If task implements ManagedTask, and taskListener is not null, the ManagedTaskListener interface methods of the task will not be called.

executionProperties - (optional) execution properties to provide additional hints to ManagedExecutorService or ManagedScheduledExecutorService when the task is submitted. If task implements ManagedTask with non-empty execution properties, the Runnable returned will contain the union of the execution properties specified in the task and the executionProperties argument, with the latter taking precedence if the same property key is specified in both. After the method is called, further changes to the Map object will not be reflected in the Callable returned by this method.

Returns:

a Callable object

Throws:

java.lang.IllegalArgumentException - if task is null