Enum State

  • All Implemented Interfaces:
    OptionsEnum, java.io.Serializable, java.lang.Comparable<State>

    public enum State
    extends java.lang.Enum<State>
    implements OptionsEnum
    • Enum Constant Detail

      • UNDEFINED

        public static final State UNDEFINED
        Unknown state on first start.
      • BELOW_LOW

        public static final State BELOW_LOW
        Value is smaller than the low threshold.
      • PASS_LOW_COMING_FROM_BELOW

        public static final State PASS_LOW_COMING_FROM_BELOW
        Value just passed the low threshold. Last value was even lower.
      • PASS_LOW_COMING_FROM_ABOVE

        public static final State PASS_LOW_COMING_FROM_ABOVE
        Value just passed the low threshold. Last value was higher.
      • BETWEEN_LOW_AND_HIGH

        public static final State BETWEEN_LOW_AND_HIGH
        Value is between low and high threshold.
      • PASS_HIGH_COMING_FROM_BELOW

        public static final State PASS_HIGH_COMING_FROM_BELOW
        Value just passed the high threshold. Last value was lower.
      • PASS_HIGH_COMING_FROM_ABOVE

        public static final State PASS_HIGH_COMING_FROM_ABOVE
        Value just passed the high threshold. Last value was higher.
      • ABOVE_HIGH

        public static final State ABOVE_HIGH
        Value is bigger than the high threshold.
    • Method Detail

      • values

        public static 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 (State c : 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 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
      • getValue

        public int getValue()
        Description copied from interface: OptionsEnum
        Gets this enums int representation.
        Specified by:
        getValue in interface OptionsEnum
        Returns:
        the int representation
      • getName

        public java.lang.String getName()
        Description copied from interface: OptionsEnum
        Gets this enums String representation.
        Specified by:
        getName in interface OptionsEnum
        Returns:
        the String representation
      • getUndefined

        public OptionsEnum getUndefined()
        Description copied from interface: OptionsEnum
        Gets the enum that is used for 'UNDEFINED' values.
        Specified by:
        getUndefined in interface OptionsEnum
        Returns:
        the UNDEFINED enum