net.lenni0451.mcstructs_bedrock.text

Enum BedrockTextFormatting

java.lang.Object

java.lang.Enum<BedrockTextFormatting>

net.lenni0451.mcstructs_bedrock.text.BedrockTextFormatting

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BedrockTextFormatting>

public enum BedrockTextFormatting
extends java.lang.Enum<BedrockTextFormatting>

The formattings are used to style texts in minecraft.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AQUA
BLACK
BLUE
BOLD
DARK_AQUA
DARK_BLUE
DARK_GRAY
DARK_GREEN
DARK_PURPLE
DARK_RED
GOLD
GRAY
GREEN
ITALIC
LIGHT_PURPLE
MATERIAL_AMETHYST
MATERIAL_COPPER
MATERIAL_DIAMOND
MATERIAL_EMERALD
MATERIAL_GOLD
MATERIAL_IRON
MATERIAL_LAPIS
MATERIAL_NETHERITE
MATERIAL_QUARTZ
MATERIAL_REDSTONE
MINECOIN_GOLD
OBFUSCATED
RED
RESET
WHITE
YELLOW

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,BedrockTextFormatting>	ALL All text formattings and colors-
static char	COLOR_CHAR The color char used for formatting.
static java.util.Map<java.lang.String,BedrockTextFormatting>	COLORS All text colors.
static java.util.Map<java.lang.String,BedrockTextFormatting>	FORMATTINGS All text formattings.

Method Summary

Modifier and Type	Method and Description
static BedrockTextFormatting	getByCode(char code) Get a formatting by code.
static BedrockTextFormatting	getByName(java.lang.String name) Get a formatting by name.
static BedrockTextFormatting	getByOrdinal(int ordinal) Get a formatting by ordinal.
static BedrockTextFormatting	getClosestFormattingColor(int rgb) Get the closest formatting color to the given rgb color.
char	getCode()
java.lang.String	getName()
int	getRgbValue()
boolean	isColor()
boolean	isFormatting()
static BedrockTextFormatting	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BedrockTextFormatting[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLACK

public static final BedrockTextFormatting BLACK

DARK_BLUE

public static final BedrockTextFormatting DARK_BLUE

DARK_GREEN

public static final BedrockTextFormatting DARK_GREEN

DARK_AQUA

public static final BedrockTextFormatting DARK_AQUA

DARK_RED

public static final BedrockTextFormatting DARK_RED

DARK_PURPLE

public static final BedrockTextFormatting DARK_PURPLE

GOLD

public static final BedrockTextFormatting GOLD

GRAY

public static final BedrockTextFormatting GRAY

DARK_GRAY

public static final BedrockTextFormatting DARK_GRAY

BLUE

public static final BedrockTextFormatting BLUE

GREEN

public static final BedrockTextFormatting GREEN

AQUA

public static final BedrockTextFormatting AQUA

RED

public static final BedrockTextFormatting RED

LIGHT_PURPLE

public static final BedrockTextFormatting LIGHT_PURPLE

YELLOW

public static final BedrockTextFormatting YELLOW

WHITE

public static final BedrockTextFormatting WHITE

MINECOIN_GOLD

public static final BedrockTextFormatting MINECOIN_GOLD

MATERIAL_QUARTZ

public static final BedrockTextFormatting MATERIAL_QUARTZ

MATERIAL_IRON

public static final BedrockTextFormatting MATERIAL_IRON

MATERIAL_NETHERITE

public static final BedrockTextFormatting MATERIAL_NETHERITE

MATERIAL_REDSTONE

public static final BedrockTextFormatting MATERIAL_REDSTONE

MATERIAL_COPPER

public static final BedrockTextFormatting MATERIAL_COPPER

MATERIAL_GOLD

public static final BedrockTextFormatting MATERIAL_GOLD

MATERIAL_EMERALD

public static final BedrockTextFormatting MATERIAL_EMERALD

MATERIAL_DIAMOND

public static final BedrockTextFormatting MATERIAL_DIAMOND

MATERIAL_LAPIS

public static final BedrockTextFormatting MATERIAL_LAPIS

MATERIAL_AMETHYST

public static final BedrockTextFormatting MATERIAL_AMETHYST

OBFUSCATED

public static final BedrockTextFormatting OBFUSCATED

BOLD

public static final BedrockTextFormatting BOLD

ITALIC

public static final BedrockTextFormatting ITALIC

RESET

public static final BedrockTextFormatting RESET

Field Detail

ALL

public static final java.util.Map<java.lang.String,BedrockTextFormatting> ALL

All text formattings and colors-

COLORS

public static final java.util.Map<java.lang.String,BedrockTextFormatting> COLORS

All text colors.

FORMATTINGS

public static final java.util.Map<java.lang.String,BedrockTextFormatting> FORMATTINGS

All text formattings.

COLOR_CHAR

public static final char COLOR_CHAR

The color char used for formatting.

See Also:

Constant Field Values

Method Detail

values

public static BedrockTextFormatting[] 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 (BedrockTextFormatting c : BedrockTextFormatting.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BedrockTextFormatting 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

getByOrdinal

@Nullable
public static BedrockTextFormatting getByOrdinal(int ordinal)

Get a formatting by ordinal.

Example:
TextFormatting.getByOrdinal(0) -> BLACK

Parameters:

ordinal - The ordinal of the formatting

Returns:

The formatting or null if not found

getByName

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

Get a formatting by name.

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

Parameters:

name - The name of the formatting

Returns:

The formatting or null if not found

getByCode

@Nullable
public static BedrockTextFormatting getByCode(char code)

Get a formatting by code.

Example:
TextFormatting.getByCode('c') -> RED

Parameters:

code - The code of the formatting

Returns:

The formatting or null if not found

getClosestFormattingColor

public static BedrockTextFormatting getClosestFormattingColor(int rgb)

Get the closest formatting color to the given rgb color.

Parameters:

rgb - The rgb color

Returns:

The closest formatting color

isColor

public boolean isColor()

Returns:

If the formatting is a 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