com.oracle.truffle.api.utilities

Enum TriState

java.lang.Object

java.lang.Enum<TriState>

com.oracle.truffle.api.utilities.TriState

All Implemented Interfaces:

Serializable, Comparable<TriState>, java.lang.constant.Constable

public enum TriState
extends Enum<TriState>

An utility value with three states, TriState.TRUE, TriState.FALSE, and TriState.UNDEFINED. TriState is preferable to using a Boolean value with Boolean.TRUE, Boolean.FALSE and null, because Boolean has a public constructor which requires the use of Boolean.equals(Object) to compare the values. The comparison with Boolean.equals(Object) is too slow.

Since:

20.2

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE The state is false.
TRUE The state is true.
UNDEFINED The state is undefined.

Method Summary

Modifier and Type	Method and Description
static TriState	valueOf(boolean b) Create a TriState from a primitive boolean.
static TriState	valueOf(Boolean b) Create a TriState from a boxed Boolean explicitely checking for null and returning TriState.UNDEFINED.
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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final TriState TRUE

The state is true. Similar to Boolean.TRUE.

Since:

20.2

FALSE

public static final TriState FALSE

The state is false. Similar to Boolean.FALSE.

Since:

20.2

UNDEFINED

public static final TriState UNDEFINED

The state is undefined. Similar to null.

Since:

20.2

Method Detail

values

public static TriState[] values()

Returns:

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

valueOf

public static TriState valueOf(String name)

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

valueOf

public static TriState valueOf(boolean b)

Create a TriState from a primitive boolean.

Since:

20.2

valueOf

public static TriState valueOf(Boolean b)

Create a TriState from a boxed Boolean explicitely checking for null and returning TriState.UNDEFINED.

Since:

20.2