LifecycleState (Apache Tomcat 7.0.109 API Documentation)

java.lang.Object
- java.lang.Enum<LifecycleState>
- - org.apache.catalina.LifecycleState

All Implemented Interfaces:

Serializable, Comparable<LifecycleState>
```
public enum LifecycleState
extends Enum<LifecycleState>
```
The list of valid states for components that implement Lifecycle. See Lifecycle for the state transition diagram.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DESTROYED`
`DESTROYING`
`FAILED`
`INITIALIZED`
`INITIALIZING`
`MUST_DESTROY` Deprecated. Unused. Will be removed in Tomcat 9.0.x. The state transition checking in `LifecycleBase` makes it impossible to use this state. The intended behaviour can be obtained by implementing `Lifecycle.SingleUse`.
`MUST_STOP` Deprecated. Unused. Will be removed in Tomcat 9.0.x. The state transition checking in `LifecycleBase` makes it impossible to use this state. The intended behaviour can be obtained by setting the state to `FAILED` in `LifecycleBase.startInternal()`
`NEW`
`STARTED`
`STARTING`
`STARTING_PREP`
`STOPPED`
`STOPPING`
`STOPPING_PREP`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getLifecycleEvent()`
`boolean`	`isAvailable()` May the public methods other than property getters/setters and lifecycle methods be called for a component in this state?
`static LifecycleState`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LifecycleState[]`	`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
  - NEW
```
public static final LifecycleState NEW
```
  - INITIALIZING
```
public static final LifecycleState INITIALIZING
```
  - INITIALIZED
```
public static final LifecycleState INITIALIZED
```
  - STARTING_PREP
```
public static final LifecycleState STARTING_PREP
```
  - STARTING
```
public static final LifecycleState STARTING
```
  - STARTED
```
public static final LifecycleState STARTED
```
  - STOPPING_PREP
```
public static final LifecycleState STOPPING_PREP
```
  - STOPPING
```
public static final LifecycleState STOPPING
```
  - STOPPED
```
public static final LifecycleState STOPPED
```
  - DESTROYING
```
public static final LifecycleState DESTROYING
```
  - DESTROYED
```
public static final LifecycleState DESTROYED
```
  - FAILED
```
public static final LifecycleState FAILED
```
  - MUST_STOP
```
@Deprecated
public static final LifecycleState MUST_STOP
```
    Deprecated. Unused. Will be removed in Tomcat 9.0.x. The state transition checking in LifecycleBase makes it impossible to use this state. The intended behaviour can be obtained by setting the state to FAILED in LifecycleBase.startInternal()
  - MUST_DESTROY
```
@Deprecated
public static final LifecycleState MUST_DESTROY
```
    Deprecated. Unused. Will be removed in Tomcat 9.0.x. The state transition checking in LifecycleBase makes it impossible to use this state. The intended behaviour can be obtained by implementing Lifecycle.SingleUse.
- Method Detail
  - values
```
public static LifecycleState[] 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 (LifecycleState c : LifecycleState.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LifecycleState 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
  - isAvailable
```
public boolean isAvailable()
```
    May the public methods other than property getters/setters and lifecycle methods be called for a component in this state? It returns true for any component in any of the following states:
    Returns:
    true if the component is available for use, otherwise false
  - getLifecycleEvent
```
public String getLifecycleEvent()
```

Enum LifecycleState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NEW

INITIALIZING

INITIALIZED

STARTING_PREP

STARTING

STARTED

STOPPING_PREP

STOPPING

STOPPED

DESTROYING

DESTROYED

FAILED

MUST_STOP

MUST_DESTROY

Method Detail

values

valueOf

isAvailable

getLifecycleEvent