Enum Class TriState

java.lang.Object
java.lang.Enum<TriState>
com.kamikazejam.kamicommon.util.data.TriState
All Implemented Interfaces:
Serializable, Comparable<TriState>, Constable
public enum TriState extends Enum<TriState>
A boolean that can also be absent, for a setting that is explicitly true, explicitly false, or simply not configured. byBoolean(Boolean) maps null to NOT_SET, while toBoolean() collapses NOT_SET back to false, so compare against the constant directly wherever "unset" and "false" must behave differently.

  • Enum Constant Details

    • NOT_SET

      public static final TriState NOT_SET

    • FALSE

      public static final TriState FALSE

    • TRUE

      public static final TriState TRUE

  • Method Details

    • values

      public static TriState[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TriState valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • byBoolean

      @NotNull public static @NotNull TriState byBoolean(boolean value)

    • byBoolean

      @NotNull public static @NotNull TriState byBoolean(@Nullable @Nullable Boolean value)

    • toBoolean

      public boolean toBoolean()