Enum Class TriState

java.lang.Object

java.lang.Enum<TriState>

dev.wyck.wrapper.environment.TriState

All Implemented Interfaces:

WrappedEnumerator<TriState>, Serializable, Comparable<TriState>, Constable

@NullMarked
@AsOf("2.4.1")
public enum TriState
extends Enum<TriState>
implements WrappedEnumerator<TriState>

Represents a tri-state value, which can be true, false, or default.

Since:

2.4.1

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT
FALSE
TRUE

Field Summary

Fields

Modifier and Type	Field	Description
static final KeyedEnumTranslator<TriState>	TRANSLATOR

Method Summary

Modifier and Type	Method	Description
static TriState	fromBoolean(@Nullable Boolean value)	Converts a boolean to a TriState.
String	getKey()	Gets the key for this enum.
KeyedEnumTranslator<TriState>	translator()	Gets the translator for this enum.
static TriState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TriState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface WrappedEnumerator

fromNms, toNms, toNms

Enum Constant Details

TRUE

public static final TriState TRUE

FALSE

public static final TriState FALSE

DEFAULT

public static final TriState DEFAULT

Field Details

TRANSLATOR

public static final KeyedEnumTranslator<TriState> TRANSLATOR

Method Details

values

public static TriState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static TriState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getKey

@AsOf("2.4.1")
public String getKey()

Gets the key for this enum.

Returns:

The key for this enum.

Since:

2.4.1

translator

@AsOf("2.4.1")
public KeyedEnumTranslator<TriState> translator()

Gets the translator for this enum.

Specified by:

translator in interface WrappedEnumerator<TriState>

Returns:

The translator for this enum.

Since:

2.4.1

fromBoolean

@AsOf("2.4.1")
public static TriState fromBoolean(@Nullable Boolean value)

Converts a boolean to a TriState.

Parameters:

value - The boolean to convert.

Returns:

The TriState equivalent of the boolean.

Since:

2.4.1