Package net.kyori.adventure.util

Enum TriState

java.lang.Object
java.lang.Enum<TriState>
net.kyori.adventure.util.TriState
All Implemented Interfaces:
Serializable, Comparable<TriState>
public enum TriState
extends Enum<TriState>
Similar to a boolean but with three states.
Since:
4.8.0

  • Enum Constant Details

    • NOT_SET

      public static final TriState NOT_SET
      State describing the absence of a value.
      Since:
      4.8.0

    • FALSE

      public static final TriState FALSE
      State describing a false value.
      Since:
      4.8.0

    • TRUE

      public static final TriState TRUE
      State describing a true value.
      Since:
      4.8.0

  • Method Details

    • values

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

    • valueOf

      public static TriState valueOf​(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:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • byBoolean

      @NotNull public static @NotNull TriState byBoolean​(boolean value)
      Gets a state from a boolean.
      Parameters:
      value - the boolean
      Returns:
      a tri-state
      Since:
      4.8.0

    • byBoolean

      @NotNull public static @NotNull TriState byBoolean​(@Nullable @Nullable Boolean value)
      Gets a state from a Boolean.
      Parameters:
      value - the boolean
      Returns:
      a tri-state
      Since:
      4.8.0