Package org.apache.catalina

Enum LifecycleState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<LifecycleState>
    public enum LifecycleState
extends java.lang.Enum<LifecycleState>
    The list of valid states for components that implement Lifecycle. See Lifecycle for the state transition diagram.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getLifecycleEvent()
      Returns the lifecycle event associated with this state.
      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​(java.lang.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
        New component, not yet initialized.

      • INITIALIZING

        public static final LifecycleState INITIALIZING
        Component is being initialized.

      • INITIALIZED

        public static final LifecycleState INITIALIZED
        Component has been initialized.

      • STARTING_PREP

        public static final LifecycleState STARTING_PREP
        Component is preparing to start.

      • STARTING

        public static final LifecycleState STARTING
        Component is starting.

      • STARTED

        public static final LifecycleState STARTED
        Component has started.

      • STOPPING_PREP

        public static final LifecycleState STOPPING_PREP
        Component is preparing to stop.

      • STOPPING

        public static final LifecycleState STOPPING
        Component is stopping.

      • STOPPED

        public static final LifecycleState STOPPED
        Component has stopped.

      • DESTROYING

        public static final LifecycleState DESTROYING
        Component is being destroyed.

      • DESTROYED

        public static final LifecycleState DESTROYED
        Component has been destroyed.

      • FAILED

        public static final LifecycleState FAILED
        Component has failed.

    • 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​(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

      • 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 java.lang.String getLifecycleEvent()
        Returns the lifecycle event associated with this state.
        Returns:
        the lifecycle event, or null