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 Summary

Enum Constants

Enum Constant	Description
FALSE	State describing a false value.
NOT_SET	State describing the absence of a value.
TRUE	State describing a true value.

Method Summary

Modifier and Type	Method	Description
static @NotNull TriState	byBoolean(boolean value)	Gets a state from a boolean.
static @NotNull TriState	byBoolean(@Nullable Boolean value)	Gets a state from a Boolean.
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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 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(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