agi.parallel.infrastructure

Enum TaskCancellationReason

java.lang.Object

java.lang.Enum<TaskCancellationReason>

agi.parallel.infrastructure.TaskCancellationReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TaskCancellationReason>

public enum TaskCancellationReason
extends java.lang.Enum<TaskCancellationReason>
implements java.io.Serializable

Indicates the reason for the task cancellation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSEQUENTIAL The task has been cancelled as a result of other task failures or cancellations.
DIRECT The task has been directly canceled by the user.
NONE Default value.

Method Summary

Modifier and Type	Method and Description
static TaskCancellationReason	getDefault() Get the enum constant that is considered to be the default.
static TaskCancellationReason	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 TaskCancellationReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TaskCancellationReason[]	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

NONE

public static final TaskCancellationReason NONE

Default value. The task has not been canceled.

DIRECT

public static final TaskCancellationReason DIRECT

The task has been directly canceled by the user.

CONSEQUENTIAL

public static final TaskCancellationReason CONSEQUENTIAL

The task has been cancelled as a result of other task failures or cancellations.

Method Detail

values

public static TaskCancellationReason[] 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 (TaskCancellationReason c : TaskCancellationReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static TaskCancellationReason valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Returns:

A numeric value.

getFromValue

public static TaskCancellationReason 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

public static TaskCancellationReason getDefault()

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

Returns:

The default enum constant.