Text Serializers

TextSerializers provide a convenient way to serialize and de-serialize Text instances. There are three applicable formats:

• Formatting Code & Legacy Format
• TextXML Format
• JSON Format
• Configuration Format

The org.spongepowered.api.text.serializer.TextSerializers class provides three TextSerializers for serializing to a representative String or deserializing to a Text instance:

• LEGACY_FORMATTING_CODE
• FORMATTING_CODE
• JSON
• TEXT_XML

Working with TextSerializers

Serializing Text

To serialize a Text object, simply use the TextSerializer#serialize method, specifying the appropriate Text object as the only argument. The method will return a String representing the Text object.

Deserializing to Text

To deserialize a String into its corresponding Text object, simply use the TextSerialize#deserialize method, specififying the input String as the only argument. If the input is incorrectly formatted, a TextParseException will be thrown. Alternatively, use the TextSerialize#deserializeUnchecked method to deserialize without any exceptions. If there is an error, the raw input will be returned in the form of a Text object.