Enum Tristate

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

    public enum Tristate
    extends java.lang.Enum<Tristate>
    Represents three different states of a setting.

    Possible values:

    • TRUE - a positive setting
    • FALSE - a negative (negated) setting
    • UNDEFINED - a non-existent setting
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FALSE
      A value indicating a negative (negated) setting.
      TRUE
      A value indicating a positive setting.
      UNDEFINED
      A value indicating a non-existent setting.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean asBoolean()
      Returns the value of the Tristate as a boolean.
      static Tristate fromBoolean​(boolean val)
      Returns a Tristate from a boolean.
      static Tristate fromNullableBoolean​(@Nullable java.lang.Boolean val)
      Returns a Tristate from a nullable boolean.
      static Tristate valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Tristate[] 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

      • TRUE

        public static final Tristate TRUE
        A value indicating a positive setting.
      • FALSE

        public static final Tristate FALSE
        A value indicating a negative (negated) setting.
      • UNDEFINED

        public static final Tristate UNDEFINED
        A value indicating a non-existent setting.
    • Method Detail

      • values

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

        public static Tristate 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
      • fromBoolean

        public static Tristate fromBoolean​(boolean val)
        Returns a Tristate from a boolean.
        Parameters:
        val - the boolean value
        Returns:
        TRUE or FALSE, if the value is true or false, respectively.
      • fromNullableBoolean

        public static Tristate fromNullableBoolean​(@Nullable java.lang.Boolean val)
        Returns a Tristate from a nullable boolean.

        Unlike fromBoolean(boolean), this method returns UNDEFINED if the value is null.

        Parameters:
        val - the boolean value
        Returns:
        UNDEFINED, TRUE or FALSE, if the value is null, true or false, respectively.
      • asBoolean

        public boolean asBoolean()
        Returns the value of the Tristate as a boolean.

        A value of UNDEFINED converts to false.

        Returns:
        a boolean representation of the Tristate.