org.oddjob.state

Enum StateConditions

java.lang.Object

java.lang.Enum<StateConditions>

org.oddjob.state.StateConditions

All Implemented Interfaces:

Serializable, Comparable<StateConditions>, StateCondition

public enum StateConditions
extends Enum<StateConditions>
implements StateCondition

These are drop in replacements for jobs that used to use a JobStates for conditions.

Author:

Rob Gordon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateConditions.Conversions The Conversion from String

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE A job that is active.
ANY Always true.
COMPLETE Is a job complete?
DESTROYED The job has been destroyed.
DONE Like COMPLETE but also stopped.
ENDED Like FINISHED but also stopped.
EXCEPTION Is a job in an exception state?
EXECUTING A state is either JobState.EXECUTING or ParentState.EXECUTING or ServiceState.STARTING.
FAILURE The state is either INCOMPLETE or EXCEPTION
FINISHED The state is either COMPLETE, INCOMPLETE or EXCEPTION
INCOMPLETE Is a job incomplete?
LIVE A job that is stoppable but not executing.
NONE Always false.
NOT_INCOMPLETE The state is either COMPLETE or EXCEPTION.
READY Is a job ready?
RUNNING Is a job executing or otherwise active?
STARTED Something, generally a service, has STARTED when it is both complete and stoppable.
SUCCESS A synonym for COMPLETE.

Method Summary

Methods

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

test

Enum Constant Detail

READY

public static final StateConditions READY

Is a job ready?

EXECUTING

public static final StateConditions EXECUTING

A state is either JobState.EXECUTING or ParentState.EXECUTING or ServiceState.STARTING.

INCOMPLETE

public static final StateConditions INCOMPLETE

Is a job incomplete?

COMPLETE

public static final StateConditions COMPLETE

Is a job complete?

EXCEPTION

public static final StateConditions EXCEPTION

Is a job in an exception state?

DESTROYED

public static final StateConditions DESTROYED

The job has been destroyed. It can no longer be used. Note that many Jobs that use state conditions will enter an EXCEPTION state if the job they trigger on is destroyed, and so this state condition will not be met.

RUNNING

public static final StateConditions RUNNING

Is a job executing or otherwise active?

SUCCESS

public static final StateConditions SUCCESS

A synonym for COMPLETE.

FAILURE

public static final StateConditions FAILURE

The state is either INCOMPLETE or EXCEPTION

NOT_INCOMPLETE

public static final StateConditions NOT_INCOMPLETE

The state is either COMPLETE or EXCEPTION.

DONE

public static final StateConditions DONE

Like COMPLETE but also stopped. Applicable to services which are complete when started.

FINISHED

public static final StateConditions FINISHED

The state is either COMPLETE, INCOMPLETE or EXCEPTION

ENDED

public static final StateConditions ENDED

Like FINISHED but also stopped. Applicable to services which are complete when started.

ACTIVE

public static final StateConditions ACTIVE

A job that is active. Indicates necessary work is still being done asynchronously, as opposed to {@link STARTED) which indicates necessary work is complete.

LIVE

public static final StateConditions LIVE

A job that is stoppable but not executing. Includes active and started jobs.

STARTED

public static final StateConditions STARTED

Something, generally a service, has STARTED when it is both complete and stoppable.

ANY

public static final StateConditions ANY

Always true.

NONE

public static final StateConditions NONE

Always false.

Method Detail

values

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

Returns:

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

valueOf

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