org.oddjob.state

Enum ServiceState

java.lang.Object

java.lang.Enum<ServiceState>

org.oddjob.state.ServiceState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ServiceState>, State

public enum ServiceState
extends java.lang.Enum<ServiceState>
implements State

Encapsulate the allowed states for a service.

Author:

Rob Gordon

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESTROYED The service has been destroyed.
EXCEPTION Indicates an exception has occurred.
STARTABLE The service can be started.
STARTED Indicates the service has started and is now available to service requests.
STARTING Indicates the service is starting.
STOPPED The service is stopped.

Method Summary

Modifier and Type	Method and Description
static ServiceState	stateFor(java.lang.String state) Utility function to convert a state text to to the JobState.
static ServiceState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ServiceState[]	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 ServiceState STARTABLE

The service can be started.

Note that this state is needed in addition to STOPPED to tie in with state transitions of job states. Without this state, an EXCEPTION state would reset to STOPPED which could cause a parent sequence to complete which would be counter intuitive compared to the behaviour of job states.

STARTING

public static final ServiceState STARTING

Indicates the service is starting. The execution thread is still in the start method.

STARTED

public static final ServiceState STARTED

Indicates the service has started and is now available to service requests.

STOPPED

public static final ServiceState STOPPED

The service is stopped.

EXCEPTION

public static final ServiceState EXCEPTION

Indicates an exception has occurred. This is generally when trying to start the service. But may also happen at other times.

DESTROYED

public static final ServiceState DESTROYED

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

Method Detail

values

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

Returns:

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

valueOf

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

stateFor

public static ServiceState stateFor(java.lang.String state)

Utility function to convert a state text to to the JobState.

Parameters:

state - Case insensitive text.

Returns:

The corresponding jobState or null if it's invalid.