Interface CharacterAndFormat
-
- All Superinterfaces:
net.kyori.examination.Examinable
@NonExtendable public interface CharacterAndFormat extends net.kyori.examination.Examinable
- Since:
- 4.14.0
-
-
Field Summary
Fields Modifier and Type Field Description static CharacterAndFormat
AQUA
Character and format pair representingNamedTextColor.AQUA
.static CharacterAndFormat
BLACK
Character and format pair representingNamedTextColor.BLACK
.static CharacterAndFormat
BLUE
Character and format pair representingNamedTextColor.BLUE
.static CharacterAndFormat
BOLD
Character and format pair representingTextDecoration.BOLD
.static CharacterAndFormat
DARK_AQUA
Character and format pair representingNamedTextColor.DARK_AQUA
.static CharacterAndFormat
DARK_BLUE
Character and format pair representingNamedTextColor.DARK_BLUE
.static CharacterAndFormat
DARK_GRAY
Character and format pair representingNamedTextColor.DARK_GRAY
.static CharacterAndFormat
DARK_GREEN
Character and format pair representingNamedTextColor.DARK_GREEN
.static CharacterAndFormat
DARK_PURPLE
Character and format pair representingNamedTextColor.DARK_PURPLE
.static CharacterAndFormat
DARK_RED
Character and format pair representingNamedTextColor.DARK_RED
.static CharacterAndFormat
GOLD
Character and format pair representingNamedTextColor.GOLD
.static CharacterAndFormat
GRAY
Character and format pair representingNamedTextColor.GRAY
.static CharacterAndFormat
GREEN
Character and format pair representingNamedTextColor.GREEN
.static CharacterAndFormat
ITALIC
Character and format pair representingTextDecoration.ITALIC
.static CharacterAndFormat
LIGHT_PURPLE
Character and format pair representingNamedTextColor.LIGHT_PURPLE
.static CharacterAndFormat
OBFUSCATED
Character and format pair representingTextDecoration.OBFUSCATED
.static CharacterAndFormat
RED
Character and format pair representingNamedTextColor.RED
.static CharacterAndFormat
RESET
Character and format pair representingReset.INSTANCE
.static CharacterAndFormat
STRIKETHROUGH
Character and format pair representingTextDecoration.STRIKETHROUGH
.static CharacterAndFormat
UNDERLINED
Character and format pair representingTextDecoration.UNDERLINED
.static CharacterAndFormat
WHITE
Character and format pair representingNamedTextColor.WHITE
.static CharacterAndFormat
YELLOW
Character and format pair representingNamedTextColor.YELLOW
.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description boolean
caseInsensitive()
If thecharacter()
is case-insensitive.char
character()
Gets the character.static @NotNull CharacterAndFormat
characterAndFormat(char character, @NotNull TextFormat format)
Creates a new combination of a case-sensitivecharacter
and aTextFormat
.static @NotNull CharacterAndFormat
characterAndFormat(char character, @NotNull TextFormat format, boolean caseInsensitive)
Creates a new combination of acharacter
and aTextFormat
.static @Unmodifiable @NotNull java.util.List<CharacterAndFormat>
defaults()
Gets an unmodifiable list of character and format instances containing all default vanilla formats.default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty>
examinableProperties()
@NotNull TextFormat
format()
Gets the format.
-
-
-
Field Detail
-
BLACK
static final CharacterAndFormat BLACK
Character and format pair representingNamedTextColor.BLACK
.- Since:
- 4.14.0
-
DARK_BLUE
static final CharacterAndFormat DARK_BLUE
Character and format pair representingNamedTextColor.DARK_BLUE
.- Since:
- 4.14.0
-
DARK_GREEN
static final CharacterAndFormat DARK_GREEN
Character and format pair representingNamedTextColor.DARK_GREEN
.- Since:
- 4.14.0
-
DARK_AQUA
static final CharacterAndFormat DARK_AQUA
Character and format pair representingNamedTextColor.DARK_AQUA
.- Since:
- 4.14.0
-
DARK_RED
static final CharacterAndFormat DARK_RED
Character and format pair representingNamedTextColor.DARK_RED
.- Since:
- 4.14.0
-
DARK_PURPLE
static final CharacterAndFormat DARK_PURPLE
Character and format pair representingNamedTextColor.DARK_PURPLE
.- Since:
- 4.14.0
-
GOLD
static final CharacterAndFormat GOLD
Character and format pair representingNamedTextColor.GOLD
.- Since:
- 4.14.0
-
GRAY
static final CharacterAndFormat GRAY
Character and format pair representingNamedTextColor.GRAY
.- Since:
- 4.14.0
-
DARK_GRAY
static final CharacterAndFormat DARK_GRAY
Character and format pair representingNamedTextColor.DARK_GRAY
.- Since:
- 4.14.0
-
BLUE
static final CharacterAndFormat BLUE
Character and format pair representingNamedTextColor.BLUE
.- Since:
- 4.14.0
-
GREEN
static final CharacterAndFormat GREEN
Character and format pair representingNamedTextColor.GREEN
.- Since:
- 4.14.0
-
AQUA
static final CharacterAndFormat AQUA
Character and format pair representingNamedTextColor.AQUA
.- Since:
- 4.14.0
-
RED
static final CharacterAndFormat RED
Character and format pair representingNamedTextColor.RED
.- Since:
- 4.14.0
-
LIGHT_PURPLE
static final CharacterAndFormat LIGHT_PURPLE
Character and format pair representingNamedTextColor.LIGHT_PURPLE
.- Since:
- 4.14.0
-
YELLOW
static final CharacterAndFormat YELLOW
Character and format pair representingNamedTextColor.YELLOW
.- Since:
- 4.14.0
-
WHITE
static final CharacterAndFormat WHITE
Character and format pair representingNamedTextColor.WHITE
.- Since:
- 4.14.0
-
OBFUSCATED
static final CharacterAndFormat OBFUSCATED
Character and format pair representingTextDecoration.OBFUSCATED
.- Since:
- 4.14.0
-
BOLD
static final CharacterAndFormat BOLD
Character and format pair representingTextDecoration.BOLD
.- Since:
- 4.14.0
-
STRIKETHROUGH
static final CharacterAndFormat STRIKETHROUGH
Character and format pair representingTextDecoration.STRIKETHROUGH
.- Since:
- 4.14.0
-
UNDERLINED
static final CharacterAndFormat UNDERLINED
Character and format pair representingTextDecoration.UNDERLINED
.- Since:
- 4.14.0
-
ITALIC
static final CharacterAndFormat ITALIC
Character and format pair representingTextDecoration.ITALIC
.- Since:
- 4.14.0
-
RESET
static final CharacterAndFormat RESET
Character and format pair representingReset.INSTANCE
.- Since:
- 4.14.0
-
-
Method Detail
-
characterAndFormat
@NotNull static @NotNull CharacterAndFormat characterAndFormat(char character, @NotNull @NotNull TextFormat format)
Creates a new combination of a case-sensitivecharacter
and aTextFormat
.- Parameters:
character
- the characterformat
- the format- Returns:
- a new character and format instance.
- Since:
- 4.14.0
-
characterAndFormat
@NotNull static @NotNull CharacterAndFormat characterAndFormat(char character, @NotNull @NotNull TextFormat format, boolean caseInsensitive)
Creates a new combination of acharacter
and aTextFormat
.- Parameters:
character
- the characterformat
- the formatcaseInsensitive
- if the character is case-insensitive- Returns:
- a new character and format instance.
- Since:
- 4.17.0
-
defaults
@NotNull static @Unmodifiable @NotNull java.util.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
@NotNull @NotNull TextFormat format()
Gets the format.- Returns:
- the format
- Since:
- 4.14.0
-
caseInsensitive
boolean caseInsensitive()
If thecharacter()
is case-insensitive.- Returns:
- if the character is case-insensitive
- Since:
- 4.17.0
-
examinableProperties
@NotNull default @NotNull java.util.stream.Stream<? extends net.kyori.examination.ExaminableProperty> examinableProperties()
- Specified by:
examinableProperties
in interfacenet.kyori.examination.Examinable
-
-