com.viaversion.viaversion.libs.mcstructs.text.stringformat

Class StringFormat

java.lang.Object

com.viaversion.viaversion.libs.mcstructs.text.stringformat.StringFormat

Direct Known Subclasses:

AdventureRgbStringFormat, AnsiStringFormat, BungeeRgbStringFormat, PrioritizingStringFormat, VanillaStringFormat, VoidVanillaStringFormat

public abstract class StringFormat
extends java.lang.Object

A class capable of reading and writing formatted strings in various formats.

Field Summary

Fields

Modifier and Type	Field and Description
protected char	colorChar

Constructor Summary

Constructors

Constructor and Description
StringFormat(char colorChar)

Method Summary

Modifier and Type	Method and Description
static StringFormat	adventure() Create a new AdventureRgbStringFormat. The color character is set to '&'.
static StringFormat	adventure(char colorChar) Create a new AdventureRgbStringFormat with the given color character.
static StringFormat	ansi() Create a new AnsiStringFormat with true color enabled.
static StringFormat	ansi(boolean trueColor) Create a new AnsiStringFormat with the given true color parameter.
static StringFormat	bungee() Create a new BungeeRgbStringFormat. The color character is set to '&'.
static StringFormat	bungee(char colorChar) Create a new BungeeRgbStringFormat with the given color character.
boolean	canRead(TextStringReader reader) Check if the reader can read the color character of this format. It is recommended to check this before calling matches(TextStringReader).
abstract boolean	canWrite(TextFormatting formatting) Check if this format can write the given text formatting.
java.lang.String	convertTo(java.lang.String s, StringFormat target) Convert a string from one format to another. Some string formats may require a reset code at the end of the string.
TextComponent	fromString(java.lang.String s, ColorHandling colorHandling, DeserializerUnknownHandling unknownHandling) Convert a string to a TextComponent. The color handling is used to determine if color codes should be treated as reset codes. The unknown handling is used to determine what should happen if an unsupported formatting is encountered. The string will be split into multiple components if multiple formatting codes are present. Empty sections will be ignored.
TextComponent	fromString(java.lang.String s, ColorHandling colorHandling, DeserializerUnknownHandling unknownHandling, boolean ignoreEmptySections) Convert a string to a TextComponent. The color handling is used to determine if color codes should be treated as reset codes. The unknown handling is used to determine what should happen if an unsupported formatting is encountered. The string will be split into multiple components if multiple formatting codes are present. Empty sections are ignored if ignoreEmptySections is true, otherwise they are included as empty components.
protected static <T> T	init(T t, java.util.function.Consumer<T> initializer)
abstract boolean	matches(TextStringReader reader) Check if the reader matches the format of this string format. This method is allowed to modify the current position of the reader.
java.lang.String	prependStyle(java.lang.String s, Style style, SerializerUnknownHandling unknownHandling) Prepend a style to the given string. This only works with formatting codes (colors, bold, italic, etc.). If the style contains an unknown formatting code the SerializerUnknownHandling will be used to resolve it.
abstract TextFormatting	read(TextStringReader reader) Read the next formatting code from the reader. The reader should be at the start of the formatting code when this method is called.
ResolvedFormatting	resolve(TextStringReader reader) Resolve the next formatting code in the string. null will be returned if no formatting code is at the current position. If the formatting code is invalid the ResolvedFormatting.get() method will return null. This is a convenience method which combines canRead(TextStringReader), matches(TextStringReader) and read(TextStringReader).
boolean	shouldResetAtEnd()
java.lang.String[]	split(java.lang.String s, java.lang.String split, ColorHandling colorHandling, SerializerUnknownHandling serializerUnknownHandling, DeserializerUnknownHandling deserializerUnknownHandling) Split a string by a given separator and keep the formatting of the previous part. The color handling is used to determine if color codes should be treated as reset codes. The unknown handling is used to determine what should happen if an unsupported formatting is encountered.
Style	styleAt(java.lang.String s, int index, ColorHandling colorHandling, DeserializerUnknownHandling unknownHandling) Get the style of a string at the given index. If the index is smaller or equal to 0 the style will be empty. If the index is greater than the length of the string the last style will be returned. If the index is in the middle of a formatting code the index will be moved to the end of the formatting code. The color handling is used to determine if color codes should be treated as reset codes. The unknown handling is used to determine what should happen if an unsupported formatting is encountered.
java.lang.String	toString(TextComponent component, ColorHandling colorHandling, SerializerUnknownHandling unknownHandling) Convert a TextComponent to a string. The unknown handling is used to determine what should happen if an unsupported formatting is encountered. A reset code will be added at the start of every new section if the previous section had any formattings. Some string formats may require a reset code at the end of the string.
java.lang.String	toString(TextComponent component, ColorHandling colorHandling, SerializerUnknownHandling unknownHandling, boolean ignoreEmptyComponents) Convert a TextComponent to a string. The unknown handling is used to determine what should happen if an unsupported formatting is encountered. A reset code will be added at the start of every new section if the previous section had any formattings. Some string formats may require a reset code at the end of the string.
static StringFormat	vanilla() Create a new VanillaStringFormat. The color character is set to '§' and rgb down sampling is disabled.
static StringFormat	vanilla(boolean downsampleRgbColors) Create a new VanillaStringFormat with the given down sampling parameter. The color character is set to '§'.
static StringFormat	vanilla(char colorChar) Create a new VanillaStringFormat with the given color character. The downsampleRgbColors parameter is set to false.
static StringFormat	vanilla(char colorChar, boolean downsampleRgbColors) Create a new VanillaStringFormat with the given color character and down sampling parameter.
abstract void	write(java.lang.StringBuilder builder, TextFormatting formatting) Write the given text formatting to the builder. This method should only be called if canWrite(TextFormatting) returns true.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

colorChar

protected final char colorChar

Constructor Detail

StringFormat

public StringFormat(char colorChar)

Method Detail

vanilla

public static StringFormat vanilla()

Create a new VanillaStringFormat.
The color character is set to '§' and rgb down sampling is disabled.

Returns:

The new string format

See Also:

VanillaStringFormat

vanilla

public static StringFormat vanilla(char colorChar)

Create a new VanillaStringFormat with the given color character.
The downsampleRgbColors parameter is set to false.

Parameters:

colorChar - The color character

Returns:

The new string format

See Also:

VanillaStringFormat

vanilla

public static StringFormat vanilla(boolean downsampleRgbColors)

Create a new VanillaStringFormat with the given down sampling parameter.
The color character is set to '§'.

Parameters:

downsampleRgbColors - Downsample rgb colors to the closest vanilla color

Returns:

The new string format

See Also:

VanillaStringFormat

vanilla

public static StringFormat vanilla(char colorChar,
                                   boolean downsampleRgbColors)

Create a new VanillaStringFormat with the given color character and down sampling parameter.

Parameters:

colorChar - The color character

downsampleRgbColors - Downsample rgb colors to the closest vanilla color

Returns:

The new string format

See Also:

VanillaStringFormat

bungee

public static StringFormat bungee()

Create a new BungeeRgbStringFormat.
The color character is set to '&'.

Returns:

The new string format

See Also:

BungeeRgbStringFormat

bungee

public static StringFormat bungee(char colorChar)

Create a new BungeeRgbStringFormat with the given color character.

Parameters:

colorChar - The color character

Returns:

The new string format

See Also:

BungeeRgbStringFormat

adventure

public static StringFormat adventure()

Create a new AdventureRgbStringFormat.
The color character is set to '&'.

Returns:

The new string format

See Also:

AdventureRgbStringFormat

adventure

public static StringFormat adventure(char colorChar)

Create a new AdventureRgbStringFormat with the given color character.

Parameters:

colorChar - The color character

Returns:

The new string format

See Also:

AdventureRgbStringFormat

ansi

public static StringFormat ansi()

Create a new AnsiStringFormat with true color enabled.

Returns:

The new string format

ansi

public static StringFormat ansi(boolean trueColor)

Create a new AnsiStringFormat with the given true color parameter.

Parameters:

trueColor - If true color should be enabled

Returns:

The new string format

fromString

public TextComponent fromString(java.lang.String s,
                                ColorHandling colorHandling,
                                DeserializerUnknownHandling unknownHandling)

Convert a string to a TextComponent.
The color handling is used to determine if color codes should be treated as reset codes.
The unknown handling is used to determine what should happen if an unsupported formatting is encountered.
The string will be split into multiple components if multiple formatting codes are present.
Empty sections will be ignored.

Parameters:

s - The string to convert

colorHandling - The color handling

unknownHandling - The unknown handling

Returns:

The converted text component

fromString

public TextComponent fromString(java.lang.String s,
                                ColorHandling colorHandling,
                                DeserializerUnknownHandling unknownHandling,
                                boolean ignoreEmptySections)

Convert a string to a TextComponent.
The color handling is used to determine if color codes should be treated as reset codes.
The unknown handling is used to determine what should happen if an unsupported formatting is encountered.
The string will be split into multiple components if multiple formatting codes are present.
Empty sections are ignored if ignoreEmptySections is true, otherwise they are included as empty components.

Parameters:

s - The string to convert

colorHandling - The color handling

unknownHandling - The unknown handling

Returns:

The converted text component

toString

public java.lang.String toString(TextComponent component,
                                 ColorHandling colorHandling,
                                 SerializerUnknownHandling unknownHandling)

Convert a TextComponent to a string.
The unknown handling is used to determine what should happen if an unsupported formatting is encountered.
A reset code will be added at the start of every new section if the previous section had any formattings.
Some string formats may require a reset code at the end of the string. It is only inserted if shouldResetAtEnd() return true and the last section had any formattings.
The style of empty components will not be applied.

Parameters:

component - The component to convert

colorHandling - The color handling

unknownHandling - The unknown handling

Returns:

The converted string

toString

public java.lang.String toString(TextComponent component,
                                 ColorHandling colorHandling,
                                 SerializerUnknownHandling unknownHandling,
                                 boolean ignoreEmptyComponents)

Convert a TextComponent to a string.
The unknown handling is used to determine what should happen if an unsupported formatting is encountered.
A reset code will be added at the start of every new section if the previous section had any formattings.
Some string formats may require a reset code at the end of the string. It is only inserted if shouldResetAtEnd() return true and the last section had any formattings.
Empty components are ignored if ignoreEmptyComponents is true, otherwise their style will be applied (and immediately overwritten by the next component's style).

Parameters:

component - The component to convert

colorHandling - The color handling

unknownHandling - The unknown handling

Returns:

The converted string

styleAt

public Style styleAt(java.lang.String s,
                     int index,
                     ColorHandling colorHandling,
                     DeserializerUnknownHandling unknownHandling)

Get the style of a string at the given index.
If the index is smaller or equal to 0 the style will be empty.
If the index is greater than the length of the string the last style will be returned.
If the index is in the middle of a formatting code the index will be moved to the end of the formatting code.
The color handling is used to determine if color codes should be treated as reset codes.
The unknown handling is used to determine what should happen if an unsupported formatting is encountered.

Parameters:

s - The string to get the style from

index - The index to get the style at

colorHandling - The color handling

unknownHandling - The unknown handling

Returns:

The style at the given index

convertTo

public java.lang.String convertTo(java.lang.String s,
                                  StringFormat target)

Convert a string from one format to another.
Some string formats may require a reset code at the end of the string. It is only inserted if shouldResetAtEnd() return true and the last section had any formattings.
If you convert from a format which requires a reset code at the end to one that doesn't, the previous reset code will not be removed automatically.

Parameters:

s - The string in the current format

target - The target format

Returns:

The string in the target format

prependStyle

public java.lang.String prependStyle(java.lang.String s,
                                     Style style,
                                     SerializerUnknownHandling unknownHandling)

Prepend a style to the given string.
This only works with formatting codes (colors, bold, italic, etc.).
If the style contains an unknown formatting code the SerializerUnknownHandling will be used to resolve it.

Parameters:

s - The string to append the style to

style - The style to append

unknownHandling - The unknown handling

Returns:

The string with the appended style

split

public java.lang.String[] split(java.lang.String s,
                                java.lang.String split,
                                ColorHandling colorHandling,
                                SerializerUnknownHandling serializerUnknownHandling,
                                DeserializerUnknownHandling deserializerUnknownHandling)

Split a string by a given separator and keep the formatting of the previous part.
The color handling is used to determine if color codes should be treated as reset codes.
The unknown handling is used to determine what should happen if an unsupported formatting is encountered.

Parameters:

s - The string to split

split - The split string

colorHandling - The color handling (for styleAt(String, int, ColorHandling, DeserializerUnknownHandling))

serializerUnknownHandling - The serializer unknown handling (for prependStyle(String, Style, SerializerUnknownHandling))

deserializerUnknownHandling - The deserializer unknown handling (for styleAt(String, int, ColorHandling, DeserializerUnknownHandling))

Returns:

The split string

resolve

@Nullable
public ResolvedFormatting resolve(TextStringReader reader)

Resolve the next formatting code in the string.
null will be returned if no formatting code is at the current position.
If the formatting code is invalid the ResolvedFormatting.get() method will return null.
This is a convenience method which combines canRead(TextStringReader), matches(TextStringReader) and read(TextStringReader).

Parameters:

reader - The reader to read from

Returns:

The resolved formatting code or null if no formatting code was found

canRead

public boolean canRead(TextStringReader reader)

Check if the reader can read the color character of this format.
It is recommended to check this before calling matches(TextStringReader).

Parameters:

reader - The reader to check

Returns:

If the reader can read the color character

matches

public abstract boolean matches(TextStringReader reader)

Check if the reader matches the format of this string format.
This method is allowed to modify the current position of the reader. It is recommended to use TextStringReader.mark() and TextStringReader.reset().

Parameters:

reader - The reader to check

Returns:

If the reader matches the format

read

@Nullable
public abstract TextFormatting read(TextStringReader reader)

Read the next formatting code from the reader.
The reader should be at the start of the formatting code when this method is called. Make sure to call matches(TextStringReader) before calling this method.
If the formatting code is invalid null should be returned.

Parameters:

reader - The reader to read from

Returns:

The read formatting code or null if the formatting code is invalid

canWrite

public abstract boolean canWrite(TextFormatting formatting)

Check if this format can write the given text formatting.

Parameters:

formatting - The formatting to check

Returns:

If this format can write the formatting

write

public abstract void write(java.lang.StringBuilder builder,
                           TextFormatting formatting)

Write the given text formatting to the builder.
This method should only be called if canWrite(TextFormatting) returns true.

Parameters:

builder - The builder to write to

formatting - The formatting to write

shouldResetAtEnd

public boolean shouldResetAtEnd()

Returns:

If a reset code should be added at the end of the string

init

protected static <T> T init(T t,
                            java.util.function.Consumer<T> initializer)