org.oddjob.state

Enum StateFlag

java.lang.Object

java.lang.Enum<StateFlag>

org.oddjob.state.StateFlag

All Implemented Interfaces:

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

public enum StateFlag
extends java.lang.Enum<StateFlag>

Flags to represent basic state.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE Is a job or service complete?
DESTROYED The job is destroyed.
EXCEPTION Is a job in an exception state.
EXECUTING Is the job executing.
INCOMPLETE Is a job or service incomplete.
READY Is a job ready to be executed.
STOPPABLE Can a job be stopped? This is a catch all for jobs that are active or executing.

Method Summary

Modifier and Type	Method and Description
static StateFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StateFlag[]	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

READY

public static final StateFlag READY

Is a job ready to be executed.

EXECUTING

public static final StateFlag EXECUTING

Is the job executing. This is normally when the thread of execution is still within the job.

STOPPABLE

public static final StateFlag STOPPABLE

Can a job be stopped? This is a catch all for jobs that are active or executing.

COMPLETE

public static final StateFlag COMPLETE

Is a job or service complete?

INCOMPLETE

public static final StateFlag INCOMPLETE

Is a job or service incomplete. The implication of incomplete is that it could be retried to be complete at some future date.

EXCEPTION

public static final StateFlag EXCEPTION

Is a job in an exception state. This is generally due to an unexpected error, as opposed to incomplete which in some way is expected.

DESTROYED

public static final StateFlag DESTROYED

The job is destroyed. It is no longer available for anything.

Method Detail

values

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

Returns:

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

valueOf

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