Enum Tristate
- All Implemented Interfaces:
Serializable
,Comparable<Tristate>
,java.lang.constant.Constable
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the value of the Tristate as a boolean.static Tristate
fromBoolean
(boolean val) Returns aTristate
from a boolean.static Tristate
fromNullableBoolean
(@Nullable Boolean val) Returns aTristate
from a nullable boolean.Returns the equivalent AdventureTriState
.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
-
TRUE
A value indicating a positive setting. -
FALSE
A value indicating a negative (negated) setting. -
UNDEFINED
A value indicating a non-existent setting.
-
-
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
-
fromBoolean
Returns aTristate
from a boolean. -
fromNullableBoolean
Returns aTristate
from a nullable boolean.Unlike
fromBoolean(boolean)
, this method returnsUNDEFINED
if the value is null. -
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.
-
toAdventureTriState
Returns the equivalent AdventureTriState
.- Returns:
- equivalent Adventure TriState
-