net.kyori.text.format

Enum TextDecoration

java.lang.Object

java.lang.Enum<TextDecoration>

net.kyori.text.format.TextDecoration

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TextDecoration>, TextFormat

public enum TextDecoration
extends java.lang.Enum<TextDecoration>
implements TextFormat

An enumeration of decorations which may be applied to a Component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextDecoration.State A state that a TextDecoration can be in.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOLD A decoration which makes text appear bold.
ITALIC A decoration which makes text appear in italics.
OBFUSCATED A decoration which makes text obfuscated/unreadable.
STRIKETHROUGH A decoration which makes text have a strike through it.
UNDERLINE A decoration which makes text have an underline.

Method Summary

Modifier and Type	Method and Description
char	legacy() Deprecated.
@NonNull java.lang.String	toString()
static TextDecoration	valueOf(java.lang.String name) 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.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBFUSCATED

@SerializedName(value="obfuscated")
public static final TextDecoration OBFUSCATED

A decoration which makes text obfuscated/unreadable.

BOLD

@SerializedName(value="bold")
public static final TextDecoration BOLD

A decoration which makes text appear bold.

STRIKETHROUGH

@SerializedName(value="strikethrough")
public static final TextDecoration STRIKETHROUGH

A decoration which makes text have a strike through it.

UNDERLINE

@SerializedName(value="underlined")
public static final TextDecoration UNDERLINE

A decoration which makes text have an underline.

ITALIC

@SerializedName(value="italic")
public static final TextDecoration ITALIC

A decoration which makes text appear in italics.

Method Detail

values

public static TextDecoration[] 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 c : TextDecoration.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 valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

legacy

@Deprecated
public char legacy()

Deprecated.

Description copied from interface: TextFormat

Gets the legacy code.

Specified by:

legacy in interface TextFormat

Returns:

the legacy code

toString

public @NonNull java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TextDecoration>