org.apache.avalon.excalibur.container
Class State

java.lang.Object
  |
  +--org.apache.avalon.framework.Enum
        |
        +--org.apache.avalon.framework.ValuedEnum
              |
              +--org.apache.avalon.excalibur.container.State

public final class State

extends org.apache.avalon.framework.ValuedEnum

Defines possible states for contained components.

Author:

Peter Donald

Field Summary

static State	CREATED CREATED is the state the component exists in after it has been successfully created but before it has been prepared.
static State	CREATING CREATING indicates that the Component is in process of being created.
static State	DESTROYED DESTROYED indicates that the component has been destroyed.
static State	DESTROYING DESTROYING indicates that the component is being destroyed.
static State	FAILED FAILED indicates that the component is in a FAILED state.
static State	READY READY indicates that the component is ready to be started or destroyed as appropriate.
static State	READYING READYING indicates that the component is being prepared for service.
static State	STARTED STARTED indicates that the component has been started.
static State	STARTING STARTING indicates that the component is being started.
static State	STOPPED STOPPED indicates that the component has been stopped.
static State	STOPPING STOPPING indicates that the component is being stopped.
static State	VOID VOID is the initial state of all components.

Constructor Summary

protected

State(java.lang.String name, int value)

Methods inherited from class org.apache.avalon.framework.ValuedEnum

getValue, isEqualTo, isGreaterThan, isGreaterThanOrEqual, isLessThan, isLessThanOrEqual, toString

Methods inherited from class org.apache.avalon.framework.Enum

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VOID

public static final State VOID

VOID is the initial state of all components.

CREATING

public static final State CREATING

CREATING indicates that the Component is in process of being created.

CREATED

public static final State CREATED

CREATED is the state the component exists in after it has been successfully created but before it has been prepared.

READYING

public static final State READYING

READYING indicates that the component is being prepared for service. In terms of Avalons Component Lifecycle this would indicate Loggable, Contextualizable, Composable, Configurable and Initializable stages.

READY

public static final State READY

READY indicates that the component is ready to be started or destroyed as appropriate.

STARTING

public static final State STARTING

STARTING indicates that the component is being started.

STARTED

public static final State STARTED

STARTED indicates that the component has been started.

STOPPING

public static final State STOPPING

STOPPING indicates that the component is being stopped.

STOPPED

public static final State STOPPED

STOPPED indicates that the component has been stopped.

DESTROYING

public static final State DESTROYING

DESTROYING indicates that the component is being destroyed.

DESTROYED

public static final State DESTROYED

DESTROYED indicates that the component has been destroyed.

FAILED

public static final State FAILED

FAILED indicates that the component is in a FAILED state. This is usually the result of an error during one of the transition states.

Constructor Detail

State

protected State(java.lang.String name,
                int value)