Modifier and Type	Class and Description
pack-priv static class	ManagedExecutors.Adapter
pack-priv static class	ManagedExecutors.CallableAdapter<V> Adapter for Callable to include ManagedTask interface methods.
pack-priv static class	ManagedExecutors.RunnableAdapter Adapter for Runnable to include ManagedTask interface methods.

Modifier and Type	Field and Description
pack-priv static final String	NULL_TASK_ERROR_MSG Error message for null tasks.

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

Method Summary

Modifier and Type	Method and Description
public static boolean	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`. isCurrentThreadShutdown() Utility method for checking the `isShutdown()` value of the current thread if it is a `ManageableThread` created from `ManagedThreadFactory.newThread()` .
public static Runnable	Returns: a Runnable object managedTask(final Runnable the task to have the given ManagedTaskListener associated with task, final ManagedTaskListener (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. 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`.
public static Runnable	Returns: a Runnable object managedTask(final Runnable the task to have the given ManagedTaskListener associated with task, final Map<String, String> (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. executionProperties, final ManagedTaskListener (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. 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`.
public static < the return type of the Callable V> Callable<V>	Returns: a Callable object managedTask(final Callable<V> the task to have the given ManagedTaskListener associated with task, final ManagedTaskListener (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. 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`.
public static < the result type of the Callable V> Callable<V>	Returns: a Callable object managedTask(final Callable<V> the task to have the given ManagedTaskListener associated with task, final Map<String, String> (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. executionProperties, final ManagedTaskListener (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. 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`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

NULL_TASK_ERROR_MSG	back to summary
pack-priv static final String NULL_TASK_ERROR_MSG Error message for null tasks.

Constructor Detail

ManagedExecutors	back to summary
private ManagedExecutors() Not suppose to create instances of this class.

Method Detail

isCurrentThreadShutdown back to summary

isCurrentThreadShutdown	back to summary
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:boolean Returns the `isShutdown()` value if the current thread is a `ManageableThread` created by `ManagedThreadFactory`, or false if the current thread is not a `ManageableThread`.

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:boolean: 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 back to summary

managedTask	back to summary
public static Runnable managedTask(final Runnable task, final ManagedTaskListener taskListener) throws 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:Runnable the task to have the given ManagedTaskListener associated with taskListener:ManagedTaskListener (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:Runnable a Runnable object Exceptions IllegalArgumentException: if `task` is `null`

public static Runnable managedTask(final Runnable task, final ManagedTaskListener taskListener) throws 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:Runnable: the task to have the given ManagedTaskListener associated with
taskListener:ManagedTaskListener: (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:Runnable

a Runnable object

Exceptions

IllegalArgumentException:: if task is null

managedTask back to summary

managedTask	back to summary
public static Runnable managedTask(final Runnable task, final Map<String, String> executionProperties, final ManagedTaskListener taskListener) throws 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:Runnable the task to have the given ManagedTaskListener associated with executionProperties:Map<String, String> (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. taskListener:ManagedTaskListener (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:Runnable a Runnable object Exceptions IllegalArgumentException: if `task` is `null`

public static Runnable managedTask(final Runnable task, final Map<String, String> executionProperties, final ManagedTaskListener taskListener) throws 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:Runnable: the task to have the given ManagedTaskListener associated with
executionProperties:Map<String, String>: (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.
taskListener:ManagedTaskListener: (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:Runnable

a Runnable object

Exceptions

IllegalArgumentException:: if task is null

managedTask back to summary

managedTask	back to summary
public static <V> Callable<V> managedTask(final Callable<V> task, final ManagedTaskListener taskListener) throws 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`. Parameters <V> the return type of the Callable task:Callable<V> the task to have the given ManagedTaskListener associated with taskListener:ManagedTaskListener (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:Callable<V> a Callable object Exceptions IllegalArgumentException: if `task` is `null`

public static <V> Callable<V> managedTask(final Callable<V> task, final ManagedTaskListener taskListener) throws 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.

Parameters

<V>: the return type of the Callable
task:Callable<V>: the task to have the given ManagedTaskListener associated with
taskListener:ManagedTaskListener: (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:Callable<V>

a Callable object

Exceptions

IllegalArgumentException:: if task is null

managedTask back to summary

managedTask	back to summary
public static <V> Callable<V> managedTask(final Callable<V> task, final Map<String, String> executionProperties, final ManagedTaskListener taskListener) throws 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`. Parameters <V> the result type of the Callable task:Callable<V> the task to have the given ManagedTaskListener associated with executionProperties:Map<String, String> (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. taskListener:ManagedTaskListener (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:Callable<V> a Callable object Exceptions IllegalArgumentException: if `task` is `null`

public static <V> Callable<V> managedTask(final Callable<V> task, final Map<String, String> executionProperties, final ManagedTaskListener taskListener) throws 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.

Parameters

<V>: the result type of the Callable
task:Callable<V>: the task to have the given ManagedTaskListener associated with
executionProperties:Map<String, String>: (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.
taskListener:ManagedTaskListener: (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:Callable<V>

a Callable object

Exceptions

IllegalArgumentException:: if task is null

jakarta.enterprise.concurrent back to summary

pack-priv Class ManagedExecutors.Adapter

Class Inheritance

extends Object
implements ManagedTask

java.lang.Object
jakarta.enterprise.concurrent.ManagedExecutors.Adapter

All Implemented Interfaces

jakarta.enterprise.concurrent.ManagedTask

Known Direct Subclasses

jakarta.enterprise.concurrent.ManagedExecutors.RunnableAdapter, jakarta.enterprise.concurrent.ManagedExecutors.CallableAdapter

Field Summary

Modifier and Type	Field and Description
private final Map<String, String>	executionProperties
private final ManagedTask	managedTask
private final ManagedTaskListener	taskListener

Constructor Summary

Access	Constructor and Description
public	Adapter(final ManagedTaskListener taskListener, final Map<String, String> executionProperties, final ManagedTask managedTask)

Method Summary

Modifier and Type	Method and Description
public Map<String, String>	getExecutionProperties() Implements jakarta.enterprise.concurrent.ManagedTask.getExecutionProperties. Provides additional information to the `ManagedExecutorService` or `ManagedScheduledExecutorService` when executing this task.
public ManagedTaskListener	getManagedTaskListener() Implements jakarta.enterprise.concurrent.ManagedTask.getManagedTaskListener. The `ManagedTaskListener` to receive notification of lifecycle events of this task.
private Map<String, String>	initExecutionProperties(final Map<String, String> base, final Map<String, String> override)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

executionProperties	back to summary
private final Map<String, String> executionProperties

managedTask	back to summary
private final ManagedTask managedTask

taskListener	back to summary
private final ManagedTaskListener taskListener

Constructor Detail

Adapter	back to summary
public Adapter(final ManagedTaskListener taskListener, final Map<String, String> executionProperties, final ManagedTask managedTask)

Method Detail

getExecutionProperties back to summary

getExecutionProperties	back to summary
public Map<String, String> getExecutionProperties() Implements jakarta.enterprise.concurrent.ManagedTask.getExecutionProperties. Doc from jakarta.enterprise.concurrent.ManagedTask.getExecutionProperties. Provides additional information to the `ManagedExecutorService` or `ManagedScheduledExecutorService` when executing this task. Some standard property keys are defined in this class. Custom property keys may be defined but must not begin with "jakarta.enterprise.concurrent.". Returns:Map<String, String> A Map<String, String> containing additional execution properties, or null if no additional information is provided for this task. Annotations @Override

public Map<String, String> getExecutionProperties()

Implements jakarta.enterprise.concurrent.ManagedTask.getExecutionProperties.

Doc from jakarta.enterprise.concurrent.ManagedTask.getExecutionProperties.

Provides additional information to the ManagedExecutorService or ManagedScheduledExecutorService when executing this task.

Some standard property keys are defined in this class. Custom property keys may be defined but must not begin with "jakarta.enterprise.concurrent.".

Returns:Map<String, String>

A Map<String, String> containing additional execution properties, or null if no additional information is provided for this task.

Annotations

@Override

getManagedTaskListener back to summary

getManagedTaskListener	back to summary
public ManagedTaskListener getManagedTaskListener() Implements jakarta.enterprise.concurrent.ManagedTask.getManagedTaskListener. Doc from jakarta.enterprise.concurrent.ManagedTask.getManagedTaskListener. The `ManagedTaskListener` to receive notification of lifecycle events of this task. Returns:ManagedTaskListener The `ManagedTaskListener` to receive notification of lifecycle events of this task, or null if it is not necessary to get notified of such events. Annotations @Override

public ManagedTaskListener getManagedTaskListener()

Implements jakarta.enterprise.concurrent.ManagedTask.getManagedTaskListener.

Doc from jakarta.enterprise.concurrent.ManagedTask.getManagedTaskListener.

The ManagedTaskListener to receive notification of lifecycle events of this task.

Returns:ManagedTaskListener

The ManagedTaskListener to receive notification of lifecycle events of this task, or null if it is not necessary to get notified of such events.

Annotations

@Override

initExecutionProperties	back to summary
private Map<String, String> initExecutionProperties(final Map<String, String> base, final Map<String, String> override)

public final Class ManagedExecutors

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ManagedExecutors.Adapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ManagedExecutors.CallableAdapter<V>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ManagedExecutors.RunnableAdapter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail