Enum Class Tristate

java.lang.Object
java.lang.Enum<Tristate>
net.luckperms.api.util.Tristate
All Implemented Interfaces:
Serializable, Comparable<Tristate>, Constable
public enum Tristate extends 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 Details

    • 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 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

    • of

      public static @NonNull Tristate of(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.

    • of

      public static @NonNull Tristate of(Boolean val)
      Returns a Tristate from a nullable boolean.

      Unlike of(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.