Package net.kyori.adventure.text.format
Enum TextDecoration
- All Implemented Interfaces:
Serializable
,Comparable<TextDecoration>
,ComponentBuilderApplicable
,StyleBuilderApplicable
,TextFormat
public enum TextDecoration
extends Enum<TextDecoration>
implements StyleBuilderApplicable, TextFormat
An enumeration of decorations which may be applied to a
Component
.- Since:
- 4.0.0
-
Nested Class Summary
-
Enum Constant Summary
Enum ConstantDescriptionA decoration which makes text appear bold.A decoration which makes text appear in italics.A decoration which makes text obfuscated/unreadable.A decoration which makes text have a strike through it.A decoration which makes text have an underline. -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal @NotNull TextDecorationAndState
as
(boolean state) Deprecated.final @NotNull TextDecorationAndState
as
(@NotNull TextDecoration.State state) Deprecated.for removal since 4.10.0, usewithState(State)
insteadvoid
styleApply
(@NotNull Style.Builder style) Applies tostyle
.@NotNull String
toString()
static TextDecoration
Returns the enum constant of this type with the specified name.static TextDecoration[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.final @NotNull TextDecorationAndState
withState
(boolean state) An alias foras(boolean)
.final @NotNull TextDecorationAndState
withState
(@NotNull TextDecoration.State state) An alias foras(State)
.final @NotNull TextDecorationAndState
An alias foras(State)
.Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
Methods inherited from interface net.kyori.adventure.text.format.StyleBuilderApplicable
componentBuilderApply
-
Enum Constant Details
-
OBFUSCATED
A decoration which makes text obfuscated/unreadable.- Since:
- 4.0.0
-
BOLD
A decoration which makes text appear bold.- Since:
- 4.0.0
-
STRIKETHROUGH
A decoration which makes text have a strike through it.- Since:
- 4.0.0
-
UNDERLINED
A decoration which makes text have an underline.- Since:
- 4.0.0
-
ITALIC
A decoration which makes text appear in italics.- Since:
- 4.0.0
-
-
Field Details
-
NAMES
The name map.- Since:
- 4.0.0
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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
-
as
Deprecated.for removal since 4.10.0, usewithState(boolean)
insteadCreates aTextDecorationAndState
, annotating this decoration with the givenstate
.- Parameters:
state
- the state- Returns:
- a
TextDecorationAndState
- Since:
- 4.8.0
-
as
@Deprecated @NotNull public final @NotNull TextDecorationAndState as(@NotNull @NotNull TextDecoration.State state) Deprecated.for removal since 4.10.0, usewithState(State)
insteadCreates aTextDecorationAndState
, annotating this decoration with the givenstate
.- Parameters:
state
- the state- Returns:
- a
TextDecorationAndState
- Since:
- 4.8.0
-
withState
An alias foras(boolean)
.- Parameters:
state
- the state- Returns:
- a
TextDecorationAndState
- Since:
- 4.10.0
-
withState
@NotNull public final @NotNull TextDecorationAndState withState(@NotNull @NotNull TextDecoration.State state) An alias foras(State)
.- Parameters:
state
- the state- Returns:
- a
TextDecorationAndState
- Since:
- 4.10.0
-
withState
An alias foras(State)
.- Parameters:
state
- the state- Returns:
- a
TextDecorationAndState
- Since:
- 4.10.0
-
styleApply
Description copied from interface:StyleBuilderApplicable
Applies tostyle
.- Specified by:
styleApply
in interfaceStyleBuilderApplicable
- Parameters:
style
- the style builder
-
toString
- Overrides:
toString
in classEnum<TextDecoration>
-
withState(boolean)
instead