org.spongepowered.api.text.serializer

Interface FormattingCodeTextSerializer

All Superinterfaces:

CatalogType, SafeTextSerializer, TextSerializer

public interface FormattingCodeTextSerializer
extends SafeTextSerializer

Represents a TextSerializer for the old "formatting code" strings. A formatted message consists out of plain text with a special character indicating a formatting follows and a unique character for each formatting.

Example: &cHello &eSponge!
With the special character & this would represent a red and yellow message. (With c, and e being the formatting characters.)

See Also:

Formatting codes on the Minecraft Wiki

Method Summary

Modifier and Type	Method and Description
char	getCharacter() Returns the formatting character for this FormattingCodeTextSerializer.
String	replaceCodes(String text, char to) Replaces the formatting codes in the specified string with a different specified character, e.g.
default String	replaceCodes(String text, FormattingCodeTextSerializer serializer) Replaces the formatting codes in the specified string with a different character for the specified FormattingCodeTextSerializer, e.g.
String	stripCodes(String text) Removes the color codes for this FormattingCodeTextSerializer from a string.

Methods inherited from interface org.spongepowered.api.text.serializer.SafeTextSerializer

deserialize, deserializeUnchecked

Methods inherited from interface org.spongepowered.api.text.serializer.TextSerializer

serialize, serializeSingle

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

getCharacter

char getCharacter()

Returns the formatting character for this FormattingCodeTextSerializer.

Returns:

The formatting character

stripCodes

String stripCodes(String text)

Removes the color codes for this FormattingCodeTextSerializer from a string.

Parameters:

text - The string

Returns:

The stripped text

replaceCodes

String replaceCodes(String text,
                    char to)

Replaces the formatting codes in the specified string with a different specified character, e.g. &cHello &eSponge! -> $cHello $eSponge!

Parameters:

text - The string to replace the formatting codes in

to - The special character to replace with

Returns:

The replaced text

replaceCodes

default String replaceCodes(String text,
                            FormattingCodeTextSerializer serializer)

Replaces the formatting codes in the specified string with a different character for the specified FormattingCodeTextSerializer, e.g. &cHello &eSponge! -> $cHello $eSponge!

Parameters:

text - The string to replace the formatting codes in

serializer - The serializer to replace for

Returns:

The replaced text