net.lenni0451.mcstructs.core

Class TextFormatting

java.lang.Object

net.lenni0451.mcstructs.core.TextFormatting

public class TextFormatting
extends java.lang.Object

Text formattings are used to style texts in minecraft.
Starting with minecraft 1.16 rgb colors have been added which also marked the end of just using § as a formatting character.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<TextFormatting>	ALL All text formattings and colors.
static TextFormatting	AQUA
static TextFormatting	BLACK
static TextFormatting	BLUE
static TextFormatting	BOLD
static char	COLOR_CHAR The color char used for formatting.
static java.util.List<TextFormatting>	COLORS All basic text colors.
static TextFormatting	DARK_AQUA
static TextFormatting	DARK_BLUE
static TextFormatting	DARK_GRAY
static TextFormatting	DARK_GREEN
static TextFormatting	DARK_PURPLE
static TextFormatting	DARK_RED
static java.util.List<TextFormatting>	FORMATTINGS All text style formattings.
static TextFormatting	GOLD
static TextFormatting	GRAY
static TextFormatting	GREEN
static TextFormatting	ITALIC
static TextFormatting	LIGHT_PURPLE
static TextFormatting	OBFUSCATED
static TextFormatting	RED
static TextFormatting	RESET
static TextFormatting	STRIKETHROUGH
static TextFormatting	UNDERLINE
static TextFormatting	WHITE
static TextFormatting	YELLOW

Constructor Summary

Constructors

Constructor and Description
TextFormatting(int rgbValue) Create a new rgb color.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
static TextFormatting	getByName(java.lang.String name) Get a formatting by name.
char	getCode()
java.lang.String	getName()
int	getRgbValue()
int	hashCode()
boolean	isColor()
boolean	isFormatting()
boolean	isFormattingColor()
boolean	isRGBColor()
static TextFormatting	parse(java.lang.String s) Get a formatting by name or a rgb color when the name starts with #.
java.lang.String	serialize()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final java.util.List<TextFormatting> ALL

All text formattings and colors.

COLORS

public static final java.util.List<TextFormatting> COLORS

All basic text colors.

FORMATTINGS

public static final java.util.List<TextFormatting> FORMATTINGS

All text style formattings.

COLOR_CHAR

public static final char COLOR_CHAR

The color char used for formatting.
Using it has been deprecated since 1.16.

See Also:

Constant Field Values

BLACK

public static final TextFormatting BLACK

DARK_BLUE

public static final TextFormatting DARK_BLUE

DARK_GREEN

public static final TextFormatting DARK_GREEN

DARK_AQUA

public static final TextFormatting DARK_AQUA

DARK_RED

public static final TextFormatting DARK_RED

DARK_PURPLE

public static final TextFormatting DARK_PURPLE

GOLD

public static final TextFormatting GOLD

GRAY

public static final TextFormatting GRAY

DARK_GRAY

public static final TextFormatting DARK_GRAY

BLUE

public static final TextFormatting BLUE

GREEN

public static final TextFormatting GREEN

AQUA

public static final TextFormatting AQUA

RED

public static final TextFormatting RED

LIGHT_PURPLE

public static final TextFormatting LIGHT_PURPLE

YELLOW

public static final TextFormatting YELLOW

WHITE

public static final TextFormatting WHITE

OBFUSCATED

public static final TextFormatting OBFUSCATED

BOLD

public static final TextFormatting BOLD

STRIKETHROUGH

public static final TextFormatting STRIKETHROUGH

UNDERLINE

public static final TextFormatting UNDERLINE

ITALIC

public static final TextFormatting ITALIC

RESET

public static final TextFormatting RESET

Constructor Detail

TextFormatting

public TextFormatting(int rgbValue)

Create a new rgb color.
Alpha values are stripped.

Parameters:

rgbValue - The rgb value

Method Detail

getByName

@Nullable
public static TextFormatting getByName(java.lang.String name)

Get a formatting by name.
The name is case-insensitive.

Example:
TextFormatting.getByName("RED") -> RED

Parameters:

name - The name of the formatting

Returns:

The formatting or null if not found

parse

@Nullable
public static TextFormatting parse(java.lang.String s)

Get a formatting by name or a rgb color when the name starts with #.
The name is case-insensitive.

Example:
TextFormatting.parse("RED") -> RED TextFormatting.parse("#FF0000") -> rgb(255, 0, 0)

Parameters:

s - The name of the formatting or a rgb color

Returns:

The formatting or null if not found

isColor

public boolean isColor()

Returns:

If the formatting is a formatting color or rgb color

isFormattingColor

public boolean isFormattingColor()

Returns:

If the formatting is a formatting color (e.g. RED)

isRGBColor

public boolean isRGBColor()

Returns:

If the formatting is a rgb color

isFormatting

public boolean isFormatting()

Returns:

If the formatting is a formatting (e.g. OBFUSCATED, BOLD, ...)

getName

public java.lang.String getName()

Returns:

The name of the formatting (e.g. "RED")

getCode

public char getCode()

Returns:

The code of the formatting (e.g. 'c')

getRgbValue

public int getRgbValue()

Returns:

The rgb value of the formatting or -1 if it's not a color

serialize

public java.lang.String serialize()

Returns:

The lowercase name of the formatting or the rgb value as a hex string if it's a rgb color

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object