Module net.kyori.adventure.text.serializer.legacy

Package net.kyori.adventure.text.serializer.legacy

Interface CharacterAndFormat

public sealed interface CharacterAndFormat

A combination of a character, a TextFormat, and if the character is caseInsensitive().

Since:

4.14.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CharacterAndFormat	AQUA	Character and format pair representing NamedTextColor.AQUA.
static final CharacterAndFormat	BLACK	Character and format pair representing NamedTextColor.BLACK.
static final CharacterAndFormat	BLUE	Character and format pair representing NamedTextColor.BLUE.
static final CharacterAndFormat	BOLD	Character and format pair representing TextDecoration.BOLD.
static final CharacterAndFormat	DARK_AQUA	Character and format pair representing NamedTextColor.DARK_AQUA.
static final CharacterAndFormat	DARK_BLUE	Character and format pair representing NamedTextColor.DARK_BLUE.
static final CharacterAndFormat	DARK_GRAY	Character and format pair representing NamedTextColor.DARK_GRAY.
static final CharacterAndFormat	DARK_GREEN	Character and format pair representing NamedTextColor.DARK_GREEN.
static final CharacterAndFormat	DARK_PURPLE	Character and format pair representing NamedTextColor.DARK_PURPLE.
static final CharacterAndFormat	DARK_RED	Character and format pair representing NamedTextColor.DARK_RED.
static final CharacterAndFormat	GOLD	Character and format pair representing NamedTextColor.GOLD.
static final CharacterAndFormat	GRAY	Character and format pair representing NamedTextColor.GRAY.
static final CharacterAndFormat	GREEN	Character and format pair representing NamedTextColor.GREEN.
static final CharacterAndFormat	ITALIC	Character and format pair representing TextDecoration.ITALIC.
static final CharacterAndFormat	LIGHT_PURPLE	Character and format pair representing NamedTextColor.LIGHT_PURPLE.
static final CharacterAndFormat	OBFUSCATED	Character and format pair representing TextDecoration.OBFUSCATED.
static final CharacterAndFormat	RED	Character and format pair representing NamedTextColor.RED.
static final CharacterAndFormat	RESET	Character and format pair representing Reset.INSTANCE.
static final CharacterAndFormat	STRIKETHROUGH	Character and format pair representing TextDecoration.STRIKETHROUGH.
static final CharacterAndFormat	UNDERLINED	Character and format pair representing TextDecoration.UNDERLINED.
static final CharacterAndFormat	WHITE	Character and format pair representing NamedTextColor.WHITE.
static final CharacterAndFormat	YELLOW	Character and format pair representing NamedTextColor.YELLOW.

Method Summary

Modifier and Type	Method	Description
boolean	caseInsensitive()	If the character() is case-insensitive.
char	character()	Gets the character.
static CharacterAndFormat	characterAndFormat(char character, TextFormat format)	Creates a new combination of a case-sensitive character and a TextFormat.
static CharacterAndFormat	characterAndFormat(char character, TextFormat format, boolean caseInsensitive)	Creates a new combination of a character and a TextFormat.
static CharacterAndFormat	characterAndReset(char character)	Creates a new combination of a case-sensitive character and the reset directive.
static CharacterAndFormat	characterAndReset(char character, boolean caseInsensitive)	Creates a new combination of a case-sensitive character and the reset directive.
static @Unmodifiable List<CharacterAndFormat>	defaults()	Gets an unmodifiable list of character and format instances containing all default vanilla formats.
@Nullable TextFormat	format()	Gets the format, or null if this format holds a reset directive.

Field Details

BLACK

static final CharacterAndFormat BLACK

Character and format pair representing NamedTextColor.BLACK.

Since:

4.14.0

DARK_BLUE

static final CharacterAndFormat DARK_BLUE

Character and format pair representing NamedTextColor.DARK_BLUE.

Since:

4.14.0

DARK_GREEN

static final CharacterAndFormat DARK_GREEN

Character and format pair representing NamedTextColor.DARK_GREEN.

Since:

4.14.0

DARK_AQUA

static final CharacterAndFormat DARK_AQUA

Character and format pair representing NamedTextColor.DARK_AQUA.

Since:

4.14.0

DARK_RED

static final CharacterAndFormat DARK_RED

Character and format pair representing NamedTextColor.DARK_RED.

Since:

4.14.0

DARK_PURPLE

static final CharacterAndFormat DARK_PURPLE

Character and format pair representing NamedTextColor.DARK_PURPLE.

Since:

4.14.0

GOLD

static final CharacterAndFormat GOLD

Character and format pair representing NamedTextColor.GOLD.

Since:

4.14.0

GRAY

static final CharacterAndFormat GRAY

Character and format pair representing NamedTextColor.GRAY.

Since:

4.14.0

DARK_GRAY

static final CharacterAndFormat DARK_GRAY

Character and format pair representing NamedTextColor.DARK_GRAY.

Since:

4.14.0

BLUE

static final CharacterAndFormat BLUE

Character and format pair representing NamedTextColor.BLUE.

Since:

4.14.0

GREEN

static final CharacterAndFormat GREEN

Character and format pair representing NamedTextColor.GREEN.

Since:

4.14.0

AQUA

static final CharacterAndFormat AQUA

Character and format pair representing NamedTextColor.AQUA.

Since:

4.14.0

RED

static final CharacterAndFormat RED

Character and format pair representing NamedTextColor.RED.

Since:

4.14.0

LIGHT_PURPLE

static final CharacterAndFormat LIGHT_PURPLE

Character and format pair representing NamedTextColor.LIGHT_PURPLE.

Since:

4.14.0

YELLOW

static final CharacterAndFormat YELLOW

Character and format pair representing NamedTextColor.YELLOW.

Since:

4.14.0

WHITE

static final CharacterAndFormat WHITE

Character and format pair representing NamedTextColor.WHITE.

Since:

4.14.0

OBFUSCATED

static final CharacterAndFormat OBFUSCATED

Character and format pair representing TextDecoration.OBFUSCATED.

Since:

4.14.0

BOLD

static final CharacterAndFormat BOLD

Character and format pair representing TextDecoration.BOLD.

Since:

4.14.0

STRIKETHROUGH

static final CharacterAndFormat STRIKETHROUGH

Character and format pair representing TextDecoration.STRIKETHROUGH.

Since:

4.14.0

UNDERLINED

static final CharacterAndFormat UNDERLINED

Character and format pair representing TextDecoration.UNDERLINED.

Since:

4.14.0

ITALIC

static final CharacterAndFormat ITALIC

Character and format pair representing TextDecoration.ITALIC.

Since:

4.14.0

RESET

static final CharacterAndFormat RESET

Character and format pair representing Reset.INSTANCE.

Since:

4.14.0

Method Details

characterAndReset

static CharacterAndFormat characterAndReset(char character)

Creates a new combination of a case-sensitive character and the reset directive.

Parameters:

character - the character

Returns:

a new character and format instance.

Since:

5.0.0

characterAndReset

static CharacterAndFormat characterAndReset(char character,
 boolean caseInsensitive)

Creates a new combination of a case-sensitive character and the reset directive.

Parameters:

character - the character

caseInsensitive - if the character is case-insensitive

Returns:

a new character and format instance.

Since:

5.0.0

characterAndFormat

static CharacterAndFormat characterAndFormat(char character,
 TextFormat format)

Creates a new combination of a case-sensitive character and a TextFormat.

Parameters:

character - the character

format - the format

Returns:

a new character and format instance.

Since:

4.14.0

characterAndFormat

static CharacterAndFormat characterAndFormat(char character,
 TextFormat format,
 boolean caseInsensitive)

Creates a new combination of a character and a TextFormat.

Parameters:

character - the character

format - the format

caseInsensitive - if the character is case-insensitive

Returns:

a new character and format instance.

Since:

4.17.0

defaults

static @Unmodifiable List<CharacterAndFormat> defaults()

Gets an unmodifiable list of character and format instances containing all default vanilla formats.

Returns:

an unmodifiable list of character and format instances containing all default vanilla formats

Since:

4.14.0

character

char character()

Gets the character.

Returns:

the character

Since:

4.14.0

format

@Nullable TextFormat format()

Gets the format, or null if this format holds a reset directive.

Returns:

the format

Since:

4.14.0

caseInsensitive

boolean caseInsensitive()

If the character() is case-insensitive.

Returns:

if the character is case-insensitive

Since:

4.17.0