agi.foundation.infrastructure.threading

(agi.foundation.core-2024r1.jar)

Enum ThreadSource

java.lang.Object

java.lang.Enum<ThreadSource>

agi.foundation.infrastructure.threading.ThreadSource

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ThreadSource>

public enum ThreadSource
extends Enum<ThreadSource>
implements Enumeration

The source of a thread used to execute a parallelizable operation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEW_THREAD The brand new thread is created and used.
THREAD_POOL The thread is recruited from the thread pool.

Method Summary

Modifier and Type	Method and Description
static ThreadSource	getDefault() Get the enum constant that is considered to be the default.
static ThreadSource	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static ThreadSource	valueOf(String name) Returns the enum constant of this type with the specified name.
static ThreadSource[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

THREAD_POOL

public static final ThreadSource THREAD_POOL

The thread is recruited from the thread pool. It is generally much faster to recruit threads from the thread pool than to create new ones. However, if a long-running operation monopolizes a thread pool thread, other parts of the application can be negatively impacted.

NEW_THREAD

public static final ThreadSource NEW_THREAD

The brand new thread is created and used. This avoids monopolizing a thread pool thread with a potentially long-running operation. However, it is much slower to create new threads than to recruit threads from the thread pool.

Method Detail

values

public static ThreadSource[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ThreadSource c : ThreadSource.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ThreadSource valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static ThreadSource getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static ThreadSource getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.