org.spongepowered.api.text.serializer

Class TextConfigSerializer

java.lang.Object

org.spongepowered.api.data.persistence.AbstractDataBuilder<Text>

org.spongepowered.api.text.serializer.TextConfigSerializer

All Implemented Interfaces:

TypeSerializer<Text>, DataBuilder<Text>, ResettableBuilder<Text,DataBuilder<Text>>

public class TextConfigSerializer
extends AbstractDataBuilder<Text>
implements TypeSerializer<Text>

Represents a TypeSerializer for Text objects. Serialization is handled by serializing the text to String with the TextSerializers.JSON serializer, loading the String into a GsonConfigurationLoader, and setting the value of the ConfigurationNode to the root node of the GsonConfigurationLoader. Although JSON is used for serialization internally, this has no effect on the actual configuration format the developer chooses to use.

Constructor Summary

Constructors

Constructor and Description
TextConfigSerializer() Creates a new TextConfigSerializer.

Method Summary

Modifier and Type	Method and Description
protected Optional<Text>	buildContent(DataView container) Builds the currently AbstractDataBuilder.supportedVersion variant of the intended DataSerializable, such that all content upgrades have already been handled by AbstractDataBuilder.build(DataView).
Text	deserialize(TypeToken<?> type, ConfigurationNode value)
void	serialize(TypeToken<?> type, Text obj, ConfigurationNode value)

Methods inherited from class org.spongepowered.api.data.persistence.AbstractDataBuilder

build

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.spongepowered.api.data.persistence.DataBuilder

from, reset

Constructor Detail

TextConfigSerializer

public TextConfigSerializer()

Creates a new TextConfigSerializer. Normally this should not need to be created more than once.

Method Detail

deserialize

public Text deserialize(TypeToken<?> type,
                        ConfigurationNode value)
                 throws ObjectMappingException

Specified by:

deserialize in interface TypeSerializer<Text>

Throws:

ObjectMappingException

serialize

public void serialize(TypeToken<?> type,
                      Text obj,
                      ConfigurationNode value)
               throws ObjectMappingException

Specified by:

serialize in interface TypeSerializer<Text>

Throws:

ObjectMappingException

buildContent

protected Optional<Text> buildContent(DataView container)
                               throws InvalidDataException

Description copied from class: AbstractDataBuilder

Builds the currently AbstractDataBuilder.supportedVersion variant of the intended DataSerializable, such that all content upgrades have already been handled by AbstractDataBuilder.build(DataView). This otherwise follows the same contract as DataBuilder.build(DataView).

Specified by:

buildContent in class AbstractDataBuilder<Text>

Parameters:

container - The container with data to build from

Returns:

The deserialized data serializable, if possible

Throws:

InvalidDataException - If there's issues of invalid data formats or invalid data