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

Class AnsiStringFormat

java.lang.Object

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

com.viaversion.viaversion.libs.mcstructs.text.stringformat.matcher.AnsiStringFormat

public class AnsiStringFormat
extends StringFormat

A StringFormat implementation for the ANSI format.
Generally used in terminals and consoles.

Field Summary

Fields inherited from class com.viaversion.viaversion.libs.mcstructs.text.stringformat.StringFormat

colorChar

Constructor Summary

Constructors

Constructor and Description
AnsiStringFormat(boolean trueColor)

Method Summary

Modifier and Type	Method and Description
boolean	canWrite(TextFormatting formatting) Check if this format can write the given text formatting.
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.
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.
boolean	shouldResetAtEnd()
void	write(java.lang.StringBuilder builder, TextFormatting formatting) Write the given text formatting to the builder. This method should only be called if StringFormat.canWrite(TextFormatting) returns true.

Methods inherited from class com.viaversion.viaversion.libs.mcstructs.text.stringformat.StringFormat

adventure, adventure, ansi, ansi, bungee, bungee, canRead, convertTo, fromString, fromString, init, prependStyle, resolve, split, styleAt, toString, toString, vanilla, vanilla, vanilla, vanilla

Methods inherited from class java.lang.Object

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

Constructor Detail

AnsiStringFormat

public AnsiStringFormat(boolean trueColor)

Method Detail

matches

public boolean matches(TextStringReader reader)

Description copied from class: StringFormat

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().

Specified by:

matches in class StringFormat

Parameters:

reader - The reader to check

Returns:

If the reader matches the format

read

@Nullable
public TextFormatting read(TextStringReader reader)

Description copied from class: StringFormat

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 StringFormat.matches(TextStringReader) before calling this method.
If the formatting code is invalid null should be returned.

Specified by:

read in class StringFormat

Parameters:

reader - The reader to read from

Returns:

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

canWrite

public boolean canWrite(TextFormatting formatting)

Description copied from class: StringFormat

Check if this format can write the given text formatting.

Specified by:

canWrite in class StringFormat

Parameters:

formatting - The formatting to check

Returns:

If this format can write the formatting

write

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

Description copied from class: StringFormat

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

Specified by:

write in class StringFormat

Parameters:

builder - The builder to write to

formatting - The formatting to write

shouldResetAtEnd

public boolean shouldResetAtEnd()

Overrides:

shouldResetAtEnd in class StringFormat

Returns:

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