Module net.kyori.adventure.api

Package net.kyori.adventure.text.format

Enum Class TextDecoration.State

java.lang.Object

java.lang.Enum<TextDecoration.State>

net.kyori.adventure.text.format.TextDecoration.State

All Implemented Interfaces:

Serializable, Comparable<TextDecoration.State>, Constable

Enclosing class:

TextDecoration

public static enum TextDecoration.State
extends Enum<TextDecoration.State>

A state that a TextDecoration can be in.

Since:

4.0.0

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	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 TextDecoration.State	byBoolean(boolean flag)	Gets a state from a boolean.
static TextDecoration.State	byBoolean(@Nullable Boolean flag)	Gets a state from a Boolean.
static TextDecoration.State	byTriState(TriState flag)	Gets a state from a TriState.
String	toString()
static TextDecoration.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TextDecoration.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_SET

public static final TextDecoration.State NOT_SET

State describing the absence of a value.

Since:

4.0.0

FALSE

public static final TextDecoration.State FALSE

State describing a false value.

Since:

4.0.0

TRUE

public static final TextDecoration.State TRUE

State describing a true value.

Since:

4.0.0

Method Details

values

public static TextDecoration.State[] 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 TextDecoration.State 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

toString

public String toString()

Overrides:

toString in class Enum<TextDecoration.State>

byBoolean

public static TextDecoration.State byBoolean(boolean flag)

Gets a state from a boolean.

Parameters:

flag - the boolean

Returns:

the state

Since:

4.0.0

byBoolean

public static TextDecoration.State byBoolean(@Nullable Boolean flag)

Gets a state from a Boolean.

Parameters:

flag - the boolean

Returns:

the state

Since:

4.0.0

byTriState

public static TextDecoration.State byTriState(TriState flag)

Gets a state from a TriState.

Parameters:

flag - the tristate

Returns:

the state

Since:

4.10.0