Package net.minecraft.util

Enum Formatting

java.lang.Object

java.lang.Enum<Formatting>

net.minecraft.util.Formatting

All Implemented Interfaces:

Serializable, Comparable<Formatting>, java.lang.constant.Constable

public enum Formatting
extends Enum<Formatting>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AQUA
BLACK
BLUE
BOLD
DARK_AQUA
DARK_BLUE
DARK_GRAY
DARK_GREEN
DARK_PURPLE
DARK_RED
GOLD
GRAY
GREEN
ITALIC
LIGHT_PURPLE
OBFUSCATED
RED
RESET
STRIKETHROUGH
UNDERLINE
WHITE
YELLOW

Field Summary

Fields

Modifier and Type	Field	Description
private static Map<String,Formatting>	BY_NAME
private char	code
private int	colorIndex
private Integer	colorValue
private static Pattern	FORMATTING_CODE_PATTERN
private boolean	modifier
private String	name
private String	stringValue

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Formatting(String name, char code, boolean modifier)
private	Formatting(String name, char code, boolean modifier, int colorIndex, Integer colorValue)
private	Formatting(String name, char code, int colorIndex, Integer colorValue)

Method Summary

Modifier and Type	Method	Description
static Formatting	byCode(char code)
static Formatting	byColorIndex(int colorIndex)
static Formatting	byName(String name)
int	getColorIndex()
Integer	getColorValue()
String	getName()
static Collection<String>	getNames(boolean colors, boolean modifiers)
boolean	isColor()
boolean	isModifier()
private static String	sanitize(String name)
static String	strip(String string)
String	toString()
static Formatting	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Formatting[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BLACK

public static final Formatting BLACK

DARK_BLUE

public static final Formatting DARK_BLUE

DARK_GREEN

public static final Formatting DARK_GREEN

DARK_AQUA

public static final Formatting DARK_AQUA

DARK_RED

public static final Formatting DARK_RED

DARK_PURPLE

public static final Formatting DARK_PURPLE

GOLD

public static final Formatting GOLD

GRAY

public static final Formatting GRAY

DARK_GRAY

public static final Formatting DARK_GRAY

BLUE

public static final Formatting BLUE

GREEN

public static final Formatting GREEN

AQUA

public static final Formatting AQUA

RED

public static final Formatting RED

LIGHT_PURPLE

public static final Formatting LIGHT_PURPLE

YELLOW

public static final Formatting YELLOW

WHITE

public static final Formatting WHITE

OBFUSCATED

public static final Formatting OBFUSCATED

BOLD

public static final Formatting BOLD

STRIKETHROUGH

public static final Formatting STRIKETHROUGH

UNDERLINE

public static final Formatting UNDERLINE

ITALIC

public static final Formatting ITALIC

RESET

public static final Formatting RESET

Field Details

BY_NAME

private static final Map<String,Formatting> BY_NAME

FORMATTING_CODE_PATTERN

private static final Pattern FORMATTING_CODE_PATTERN

name

private final String name

code

private final char code

modifier

private final boolean modifier

stringValue

private final String stringValue

colorIndex

private final int colorIndex

colorValue

@Nullable private final Integer colorValue

Constructor Details

Formatting

private Formatting(String name, char code, int colorIndex, Integer colorValue)

Formatting

private Formatting(String name, char code, boolean modifier)

Formatting

private Formatting(String name, char code, boolean modifier, int colorIndex, Integer colorValue)

Method Details

values

public static Formatting[] values()

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

Returns:

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

valueOf

public static Formatting valueOf(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:

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

NullPointerException - if the argument is null

sanitize

private static String sanitize(String name)

getColorIndex

public int getColorIndex()

isModifier

public boolean isModifier()

isColor

public boolean isColor()

getColorValue

@Nullable public Integer getColorValue()

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Enum<Formatting>

strip

@Nullable public static String strip(@Nullable String string)

byName

@Nullable public static Formatting byName(@Nullable String name)

byColorIndex

@Nullable public static Formatting byColorIndex(int colorIndex)

byCode

@Environment(CLIENT) @Nullable public static Formatting byCode(char code)

getNames

public static Collection<String> getNames(boolean colors, boolean modifiers)