org.oddjob.scheduling.state

Enum TimerState

java.lang.Object

java.lang.Enum<TimerState>

org.oddjob.scheduling.state.TimerState

All Implemented Interfaces:

Serializable, Comparable<TimerState>, State

public enum TimerState
extends Enum<TimerState>
implements State

Encapsulate the allowed states for Timers.

Author:

Rob Gordon

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Indicates that child jobs are active.
COMPLETE The timer is complete and the child job is complete.
DESTROYED The timer has been destroyed.
EXCEPTION The timer failed to Start or the timer is complete but is reflecting the child's exception state.
INCOMPLETE The timer is complete but is reflecting that the child job is incomplete.
STARTABLE The timer can be started.
STARTED The timer has started.
STARTING The timer is starting.

Method Summary

Methods

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

Methods inherited from interface org.oddjob.state.State

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

Enum Constant Detail

STARTABLE

public static final TimerState STARTABLE

The timer can be started. A timer can not be started unless it is in this state.

STARTING

public static final TimerState STARTING

The timer is starting.

ACTIVE

public static final TimerState ACTIVE

Indicates that child jobs are active. A Timer will only show this state when it has completed but a child job is being re-run.

STARTED

public static final TimerState STARTED

The timer has started.

INCOMPLETE

public static final TimerState INCOMPLETE

The timer is complete but is reflecting that the child job is incomplete.

COMPLETE

public static final TimerState COMPLETE

The timer is complete and the child job is complete.

EXCEPTION

public static final TimerState EXCEPTION

The timer failed to Start or the timer is complete but is reflecting the child's exception state.

DESTROYED

public static final TimerState DESTROYED

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

Method Detail

values

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

Returns:

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

valueOf

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