org.spongepowered.api.text.serializer

Interface TextSerializer

All Superinterfaces:

CatalogType

All Known Subinterfaces:

FormattingCodeTextSerializer, SafeTextSerializer

@CatalogedBy(value=TextSerializers.class)
public interface TextSerializer
extends CatalogType

Represents a serializer for Text instances that converts an input string into a formatted Text instance, or a Text instance into the string representation.

Custom implementations can be registered using the GameRegistry.

Method Summary

Modifier and Type	Method and Description
Text	deserialize(String input) Returns a Text instance from an appropriately formatted string.
default Text	deserializeUnchecked(String input) Tries to return a Text instance from the provided input string.
String	serialize(Text text) Returns a string representation of the provided Text in a format that will be accepted by this TextSerializer's deserialize(String) method.
default String	serializeSingle(Text text) Returns a string representation of only the provided Text (without any children) in a format that will be accepted by this TextSerializer's deserialize(String) method.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

serialize

String serialize(Text text)

Returns a string representation of the provided Text in a format that will be accepted by this TextSerializer's deserialize(String) method.

Parameters:

text - The text to serialize

Returns:

The string representation of this text

serializeSingle

default String serializeSingle(Text text)

Returns a string representation of only the provided Text (without any children) in a format that will be accepted by this TextSerializer's deserialize(String) method.

Parameters:

text - The text to serialize

Returns:

The string representation of this text (without any children)

deserialize

Text deserialize(String input)
          throws TextParseException

Returns a Text instance from an appropriately formatted string.

Parameters:

input - The raw input to parse into a text

Returns:

The parsed text for the input string

Throws:

TextParseException - If an error occurs while parsing the text

deserializeUnchecked

default Text deserializeUnchecked(String input)

Tries to return a Text instance from the provided input string. However, if the input string is not of a valid format, the returned Text object will be of the raw input, rather than throwing an exception.

Parameters:

input - The raw input to try to parse into a text

Returns:

The parsed text for the input string, or the raw input