Package org.oddjob.jobs.tasks

Enum Class TaskState

java.lang.Object

java.lang.Enum<TaskState>

org.oddjob.jobs.tasks.TaskState

All Implemented Interfaces:

Serializable, Comparable<TaskState>, Constable, State

public enum TaskState
extends Enum<TaskState>
implements State

Encapsulate the allowed states for a Task.

Author:

Rob Gordon

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETE	Indicates task has completed successfully.
DESTROYED	The job has been destroyed.
EXCEPTION	Indicates an exception has occurred.
INCOMPLETE	Indicates the task failed to complete.
INPROGRESS	In progress
PENDING	The task hasn't started.

Method Summary

Modifier and Type	Method	Description
static TaskState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TaskState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.oddjob.state.State

isComplete, isDestroyed, isException, isExecuting, isIncomplete, isReady, isStoppable

Enum Constant Details

PENDING

public static final TaskState PENDING

The task hasn't started.

INPROGRESS

public static final TaskState INPROGRESS

In progress

INCOMPLETE

public static final TaskState INCOMPLETE

Indicates the task failed to complete.

COMPLETE

public static final TaskState COMPLETE

Indicates task has completed successfully.

EXCEPTION

public static final TaskState EXCEPTION

Indicates an exception has occurred.

DESTROYED

public static final TaskState DESTROYED

The job has been destroyed. It can no longer be used.

Method Details

values

public static TaskState[] 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 TaskState 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