Package net.kyori.adventure.text.format
Enum TextDecoration.State
- java.lang.Object
-
- java.lang.Enum<TextDecoration.State>
-
- net.kyori.adventure.text.format.TextDecoration.State
-
- All Implemented Interfaces:
Serializable
,Comparable<TextDecoration.State>
- Enclosing class:
- TextDecoration
public static enum TextDecoration.State extends Enum<TextDecoration.State>
A state that aTextDecoration
can be in.- Since:
- 4.0.0
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static @NotNull TextDecoration.State
byBoolean(boolean flag)
Gets a state from aboolean
.static @NotNull TextDecoration.State
byBoolean(@Nullable Boolean flag)
Gets a state from aBoolean
.static @NotNull TextDecoration.State
byTriState(@NotNull TriState flag)
Gets a state from aTriState
.String
toString()
static TextDecoration.State
valueOf(String name)
Returns the enum constant of this type with the specified name.static TextDecoration.State[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 afalse
value.- Since:
- 4.0.0
-
TRUE
public static final TextDecoration.State TRUE
State describing atrue
value.- Since:
- 4.0.0
-
-
Method Detail
-
values
public static TextDecoration.State[] 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 (TextDecoration.State c : TextDecoration.State.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TextDecoration.State 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 nameNullPointerException
- if the argument is null
-
toString
public String toString()
- Overrides:
toString
in classEnum<TextDecoration.State>
-
byBoolean
@NotNull public static @NotNull TextDecoration.State byBoolean(boolean flag)
Gets a state from aboolean
.- Parameters:
flag
- the boolean- Returns:
- the state
- Since:
- 4.0.0
-
byBoolean
@NotNull public static @NotNull TextDecoration.State byBoolean(@Nullable @Nullable Boolean flag)
Gets a state from aBoolean
.- Parameters:
flag
- the boolean- Returns:
- the state
- Since:
- 4.0.0
-
byTriState
@NotNull public static @NotNull TextDecoration.State byTriState(@NotNull @NotNull TriState flag)
Gets a state from aTriState
.- Parameters:
flag
- the tristate- Returns:
- the state
- Since:
- 4.10.0
-
-