Enum Class TaskGroupStatus

java.lang.Object

java.lang.Enum<TaskGroupStatus>

co.yellowdog.platform.model.TaskGroupStatus

All Implemented Interfaces:

Serializable, Comparable<TaskGroupStatus>, Constable

public enum TaskGroupStatus
extends Enum<TaskGroupStatus>

Describes the status of a task group.
The status of the task group provides an aggregated view of the statuses of tasks within the task group.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	The parent work requirement has been cancelled, no tasks are currently being executed or will be executed.
CANCELLING	The parent work requirement is in the process of being cancelled, no further tasks will be executed.
COMPLETED	All tasks within the task group have finished and none have failed.
FAILED	All tasks within the task group have finished but at least one has failed, or a task group it depends on has failed.
FAILING	At least one task in the task group has failed, or a task group it depends on has failed, and the task group is in the process of discarding any outstanding tasks.
FINISHING	The task group is waiting for all tasks to finish, no further tasks can be added. minWorkers is no longer enforced to allow all workers to be released as tasks finish.
HELD	The task group parent work requirement has been held by the user such that no further tasks are executed.
PENDING	The task group is waiting for the task groups it depends on to complete.
RUNNING	The task group can execute tasks, on Workers as they are claimed for it.

Method Summary

Modifier and Type	Method	Description
boolean	isActive()	Returns true, if the status indicates the task group is still able to allocate tasks to execute; otherwise, false.
boolean	isTerminal()
boolean	isTerminated()	Returns true, if the status indicates the task group has reached a terminal state; otherwise, false.
boolean	isTerminating()	Returns true, if the status indicates the task group is approaching a terminal state; otherwise, false.
static TaskGroupStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TaskGroupStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PENDING

public static final TaskGroupStatus PENDING

The task group is waiting for the task groups it depends on to complete.

RUNNING

public static final TaskGroupStatus RUNNING

The task group can execute tasks, on Workers as they are claimed for it.

HELD

public static final TaskGroupStatus HELD

The task group parent work requirement has been held by the user such that no further tasks are executed. Resources (e.g. Workers) will be released The task group will remain in HELD state until the user reactivates the parent work requirement.

FINISHING

public static final TaskGroupStatus FINISHING

The task group is waiting for all tasks to finish, no further tasks can be added. minWorkers is no longer enforced to allow all workers to be released as tasks finish.

COMPLETED

public static final TaskGroupStatus COMPLETED

All tasks within the task group have finished and none have failed.

FAILING

public static final TaskGroupStatus FAILING

At least one task in the task group has failed, or a task group it depends on has failed, and the task group is in the process of discarding any outstanding tasks.

FAILED

public static final TaskGroupStatus FAILED

All tasks within the task group have finished but at least one has failed, or a task group it depends on has failed.

CANCELLING

public static final TaskGroupStatus CANCELLING

The parent work requirement is in the process of being cancelled, no further tasks will be executed.

CANCELLED

public static final TaskGroupStatus CANCELLED

The parent work requirement has been cancelled, no tasks are currently being executed or will be executed.

Method Details

values

public static TaskGroupStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TaskGroupStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isTerminal

public boolean isTerminal()

isTerminating

public boolean isTerminating()

Returns true, if the status indicates the task group is approaching a terminal state; otherwise, false.

Returns:

true, if the status indicates the task group is approaching a terminal state; otherwise, false

isTerminated

public boolean isTerminated()

Returns true, if the status indicates the task group has reached a terminal state; otherwise, false.

Returns:

true, if the status indicates the task group has reaching a terminal state; otherwise, false

isActive

public boolean isActive()

Returns true, if the status indicates the task group is still able to allocate tasks to execute; otherwise, false.

Returns:

true, if the status indicates the task group is still able to allocate tasks to execute; otherwise, false