Package net.kyori.adventure.util
Enum TriState
- All Implemented Interfaces:
Serializable
,Comparable<TriState>
Similar to a
boolean
but with three states.- Since:
- 4.8.0
-
Enum Constant Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull TriState
byBoolean
(boolean value) Gets a state from aboolean
.static @NotNull TriState
Gets a state from aBoolean
.@Nullable Boolean
Converts this tri-state back into aBoolean
.boolean
toBooleanOrElse
(boolean other) Converts this tri-state back into aboolean
.boolean
toBooleanOrElseGet
(@NotNull BooleanSupplier supplier) Converts this tri-state back into aboolean
.static TriState
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
-
toBoolean
Converts this tri-state back into aBoolean
.- Returns:
- the boolean representing this tri-state.
NOT_SET
will be represented bynull
. - Since:
- 4.10.0
-
toBooleanOrElse
public boolean toBooleanOrElse(boolean other) Converts this tri-state back into aboolean
.As the
NOT_SET
state cannot be represented by the boolean type, this method maps theNOT_SET
state to other passed boolean value. This method may hence also be viewed as an equivalent toOptional.orElse(Object)
. -
toBooleanOrElseGet
Converts this tri-state back into aboolean
.As the
NOT_SET
state cannot be represented by the boolean type, this method maps theNOT_SET
state to the suppliers result. This method may hence also be viewed as an equivalent toOptional.orElseGet(java.util.function.Supplier)
. -
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
-