io.github.mrblobman.nbt

Class SerializationContext

java.lang.Object

io.github.mrblobman.nbt.SerializationContext

public class SerializationContext
extends java.lang.Object

The SerializationContext contains serializers, deserializers, and the factory used by them all. An NBTSerializer or NBTDeserializer can and should delegate serialization of complex types to this context that will find the appropriate NBTSerializer or NBTDeserializer for the job. Each should only be responsible for the name of the key that the complex type is at and the primitive fields (including strings and lists of primitives).

Method Summary

Modifier and Type	Method and Description
boolean	canDeserialize(java.lang.Class type) Check if this context is able to deserialize the given type.
boolean	canSerialize(java.lang.Class type) Check if this context is able to serialize the given type.
<T> T	deserialize(NBTBaseTag tag, java.lang.Class<T> type) Deserialize the tag into an object of the given type.
TagFactory	factory() Obtain the tag factory used in serialization and deserialization.
NBTBaseTag	serialize(java.lang.Object data) Serialize the given data as an NBTBaseTag.
<T,S extends T> NBTBaseTag	serialize(S data, java.lang.Class<T> type) Serialize the given data as an NBTBaseTag

Methods inherited from class java.lang.Object

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

Method Detail

deserialize

public <T> T deserialize(NBTBaseTag tag,
                         java.lang.Class<T> type)

Deserialize the tag into an object of the given type.

Type Parameters:

T - the type of the object represented by the serialized tag

Parameters:

tag - the raw data tag

type - the class of the serialized object

Returns:

the deserializer object

Throws:

NBTDeserializationException - if a deserializer cannot be found for the given type or the deserializer throws an exception.

serialize

public NBTBaseTag serialize(java.lang.Object data)

Serialize the given data as an NBTBaseTag.

Parameters:

data - the data to serialize

Returns:

the serialized form of the data

Throws:

NBTSerializationException - if a serializer for the class of the data cannot be found or an exception is raised during serialization.

serialize

public <T,S extends T> NBTBaseTag serialize(S data,
                                            java.lang.Class<T> type)

Serialize the given data as an NBTBaseTag

Type Parameters:

T - the type of the serializing data, think of this as the type to down cast to

S - the type of the data, it must be T or a sub class of T

Parameters:

data - the data to serialize

type - the class that the serializer is able to serialize

Returns:

the serialized form of the data

Throws:

NBTSerializationException - if a serializer for the given type is not found or an exception is raised during serialization.

canDeserialize

public boolean canDeserialize(java.lang.Class type)

Check if this context is able to deserialize the given type.

Parameters:

type - the class of the object to deserialize

Returns:

true if this context can attempt to deserialize an object of class type, false otherwise.

canSerialize

public boolean canSerialize(java.lang.Class type)

Check if this context is able to serialize the given type.

Parameters:

type - the class of the object to serialize

Returns:

true if this context can attempt to serialize an object of class type, false otherwise.

factory

public TagFactory factory()

Obtain the tag factory used in serialization and deserialization. This method is designed for use by NBTSerializers and NBTDeserializers as the context is always passed with a serialization or deserialization request.

Returns:

the appropriate TagFactory for wrapping and instantiating tags.