org.spongepowered.api.data.persistence

Interface DataTranslator<T>

Type Parameters:

T - The type of object that this translator can handle

All Superinterfaces:

CatalogType

@CatalogedBy(value=DataTranslators.class)
public interface DataTranslator<T>
extends CatalogType

A compatibility object to translate and translate any type of Object that is not a DataSerializable. Natively, DataView will attempt to locate a DataTranslator during DataView.set(DataQuery, Object).

Method Summary

Modifier and Type	Method and Description
default DataView	addTo(T obj, DataView dataView) Serializes the T object and applies the provided data to the provided DataView instead of creating a new DataContainer, reducing nested information.
TypeToken<T>	getToken() Gets the TypeToken of this translator.
T	translate(DataView view) Attempts to translate the T object from the provided DataView.
DataContainer	translate(T obj) Serializes the provided object to a DataContainer.

Methods inherited from interface org.spongepowered.api.CatalogType

getId, getName

Method Detail

getToken

TypeToken<T> getToken()

Gets the TypeToken of this translator.

Returns:

The type token for this translator

See Also:

TypeToken

translate

T translate(DataView view)
     throws InvalidDataException

Attempts to translate the T object from the provided DataView.

Parameters:

view - The data view to translate the object from

Returns:

The deserialized object

Throws:

InvalidDataException - If the dataview contained invalid data

translate

DataContainer translate(T obj)
                 throws InvalidDataException

Serializes the provided object to a DataContainer.

Parameters:

obj - The object to translate

Returns:

The object serialized to a container

Throws:

InvalidDataException - If the desired object is not supported for any reason

addTo

default DataView addTo(T obj,
                       DataView dataView)

Serializes the T object and applies the provided data to the provided DataView instead of creating a new DataContainer, reducing nested information.

Parameters:

obj - The object to serialize

dataView - The data view to serialize to

Returns:

The provided data view, for chaining