Package org.apache.kafka.streams.processor.internals

Enum GlobalStreamThread.State

  • All Implemented Interfaces:
    Serializable, Comparable<GlobalStreamThread.State>, ThreadStateTransitionValidator
    Enclosing class:
    GlobalStreamThread
    public static enum GlobalStreamThread.State
extends Enum<GlobalStreamThread.State>
implements ThreadStateTransitionValidator
    The states that the global stream thread can be in 
                    +-------------+
          +<--- | Created (0) |
          |     +-----+-------+
          |           |
          |           v
          |     +-----+-------+
          +<--- | Running (1) |
          |     +-----+-------+
          |           |
          |           v
          |     +-----+-------+
          +---> | Pending     |
                | Shutdown (2)|
                +-----+-------+
                      |
                      v
                +-----+-------+
                | Dead (3)    |
                +-------------+
    Note the following:
    • Any state can go to PENDING_SHUTDOWN. That is because streams can be closed at any time.
    • State PENDING_SHUTDOWN may want to transit itself. In this case we will forbid the transition but will not treat as an error.

    • Method Detail

      • values

        public static GlobalStreamThread.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 (GlobalStreamThread.State c : GlobalStreamThread.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 GlobalStreamThread.State 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

      • isRunning

        public boolean isRunning()