Package net.kyori.adventure.util
Enum TriState
- java.lang.Object
-
- java.lang.Enum<TriState>
-
- net.kyori.adventure.util.TriState
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static @NotNull TriState
byBoolean(boolean value)
Gets a state from aboolean
.static @NotNull TriState
byBoolean(@Nullable java.lang.Boolean value)
Gets a state from aBoolean
.@Nullable java.lang.Boolean
toBoolean()
Converts this tri-state back into aBoolean
.boolean
toBooleanOrElse(boolean other)
Converts this tri-state back into aboolean
.boolean
toBooleanOrElseGet(@NotNull java.util.function.BooleanSupplier supplier)
Converts this tri-state back into aboolean
.static TriState
valueOf(java.lang.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.
-
-
-
Method Detail
-
values
public static TriState[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (TriState c : TriState.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TriState valueOf(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
toBoolean
@Nullable public @Nullable java.lang.Boolean 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)
-
toBooleanOrElseGet
public boolean toBooleanOrElseGet(@NotNull @NotNull java.util.function.BooleanSupplier supplier)
-
byBoolean
@NotNull public static @NotNull TriState byBoolean(boolean value)
Gets a state from aboolean
.- Parameters:
value
- the boolean- Returns:
- a tri-state
- Since:
- 4.8.0
-
byBoolean
@NotNull public static @NotNull TriState byBoolean(@Nullable @Nullable java.lang.Boolean value)
Gets a state from aBoolean
.- Parameters:
value
- the boolean- Returns:
- a tri-state
- Since:
- 4.8.0
-
-