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 Summary

      Enum Constants 
      Enum Constant Description
      OFF
      Value is larger than the high threshold.
      ON
      Value is smaller than the low threshold.
      UNDEFINED
      Unknown state on first start or Value is larger than the low threshold and smaller than the high threshold.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Gets this enums String representation.
      OptionsEnum getUndefined()
      Gets the enum that is used for 'UNDEFINED' values.
      int getValue()
      Gets this enums int representation.
      static State valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static 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

        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

      • UNDEFINED

        public static final State UNDEFINED
        Unknown state on first start or Value is larger than the low threshold and smaller than the high threshold.
      • ON

        public static final State ON
        Value is smaller than the low threshold.
      • OFF

        public static final State OFF
        Value is larger 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