Package net.kyori.adventure.util
Enum 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 Summary
-
Method Summary
Modifier and Type Method Description static @NotNull TriState
byBoolean(boolean value)
Gets a state from aboolean
.static @NotNull TriState
byBoolean(@Nullable Boolean value)
Gets a state from aBoolean
.static TriState
valueOf(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.
-
Enum Constant Details
-
NOT_SET
State describing the absence of a value.- Since:
- 4.8.0
-
FALSE
State describing afalse
value.- Since:
- 4.8.0
-
TRUE
State describing atrue
value.- Since:
- 4.8.0
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
byBoolean
Gets a state from aboolean
.- Parameters:
value
- the boolean- Returns:
- a tri-state
- Since:
- 4.8.0
-
byBoolean
Gets a state from aBoolean
.- Parameters:
value
- the boolean- Returns:
- a tri-state
- Since:
- 4.8.0
-