Package com.google.common.util.concurrent

Enum Service.State

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Service.State>
    Enclosing interface:
    Service
    @Beta
public static enum Service.State
extends java.lang.Enum<Service.State>
    The lifecycle states of a service.

    The ordering of the Service.State enum is defined such that if there is a state transition from A -> B then A.compareTo(B < 0}. N.B. The converse is not true, i.e. if A.compareTo(B < 0} then there is not guaranteed to be a valid state transition A -> B.

    Since:
    9.0 (in 1.0 as com.google.common.base.Service.State)

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FAILED
      A service in this state has encountered a problem and may not be operational.
      NEW
      A service in this state is inactive.
      RUNNING
      A service in this state is operational.
      STARTING
      A service in this state is transitioning to RUNNING.
      STOPPING
      A service in this state is transitioning to TERMINATED.
      TERMINATED
      A service in this state has completed execution normally.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Service.State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Service.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, 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 Service.State NEW
        A service in this state is inactive. It does minimal work and consumes minimal resources.

      • STARTING

        public static final Service.State STARTING
        A service in this state is transitioning to RUNNING.

      • RUNNING

        public static final Service.State RUNNING
        A service in this state is operational.

      • TERMINATED

        public static final Service.State TERMINATED
        A service in this state has completed execution normally. It does minimal work and consumes minimal resources.

      • FAILED

        public static final Service.State FAILED
        A service in this state has encountered a problem and may not be operational. It cannot be started nor stopped.

    • Method Detail

      • values

        public static Service.State[] 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 (Service.State c : Service.State.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Service.State 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