org.radix.serialization2

Class Serialization

java.lang.Object

org.radix.serialization2.Serialization

public class Serialization
extends java.lang.Object

Serialization class that handles conversion to/from DSON and JSON.

Method Summary

Modifier and Type	Method and Description
static Serialization	create(SerializerIds idLookup, SerializationPolicy policy) Create a new instance of Serialization with the specified IDs and policy.
DsonJavaType	dsonCollectionType(java.lang.Class<? extends java.util.Collection> collectionClass, java.lang.Class<?> elementClass) Return a collection type for use with the fromDson(byte[], DsonJavaType) method.
<T> T	fromDson(byte[] bytes, java.lang.Class<T> valueType) Convert the specified DSON encoded byte array to an instance of the specified class.
<T> T	fromDson(byte[] bytes, DsonJavaType valueType) Convert the specified DSON encoded byte array to an instance of the specified class.
<T> T	fromJson(java.lang.String json, java.lang.Class<T> valueType) Convert the specified JSON encoded string to an instance of the specified class.
<T> T	fromJson(java.lang.String json, JsonJavaType valueType) Convert the specified JSON encoded string to an instance of the specified class.
<T> T	fromJsonObject(org.json.JSONObject json, java.lang.Class<T> valueType) Convert the specified JSONObject to an instance of the specified class.
java.lang.Class<?>	getClassForId(java.lang.String id) Retrieve class given a serializer ID.
java.lang.String	getIdForClass(java.lang.Class<?> cls) Retrieve serializer ID from class.
JsonJavaType	jsonCollectionType(java.lang.Class<? extends java.util.Collection> collectionClass, java.lang.Class<?> elementClass) Return a collection type for use with the fromJson(String, JsonJavaType) method.
byte[]	toDson(java.lang.Object o, DsonOutput.Output output) Convert the specified object to DSON encoded bytes for the specified output mode.
java.lang.String	toJson(java.lang.Object o, DsonOutput.Output output) Convert the specified object to a JSON encoded string for the specified output mode.
org.json.JSONObject	toJsonObject(java.lang.Object o, DsonOutput.Output output) Convert the specified object to a JSONObject encoded string for the specified output mode.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Serialization create(SerializerIds idLookup,
                                   SerializationPolicy policy)

Create a new instance of Serialization with the specified IDs and policy.

Parameters:

idLookup - The SerializerIds to use for class and property lookup.

policy - The SerializationPolicy to use for determining serialization outputs.

Returns:

A new instance of Serialization.

toDson

public byte[] toDson(java.lang.Object o,
                     DsonOutput.Output output)
              throws SerializationException

Convert the specified object to DSON encoded bytes for the specified output mode.

Parameters:

o - The object to serialize

output - The output mode to serialize for

Returns:

The serialized object as a DSON byte array

Throws:

SerializationException - if something goes wrong with serialization

toJson

public java.lang.String toJson(java.lang.Object o,
                               DsonOutput.Output output)
                        throws SerializationException

Convert the specified object to a JSON encoded string for the specified output mode.

Parameters:

o - The object to serialize

output - The output mode to serialize for

Returns:

The serialized object as a JSON string

Throws:

SerializationException - if something goes wrong with serialization

toJsonObject

public org.json.JSONObject toJsonObject(java.lang.Object o,
                                        DsonOutput.Output output)

Convert the specified object to a JSONObject encoded string for the specified output mode.

Parameters:

o - The object to serialize

output - The output mode to serialize for

Returns:

The serialized object as a JSON string

fromDson

public <T> T fromDson(byte[] bytes,
                      java.lang.Class<T> valueType)
               throws SerializationException

Convert the specified DSON encoded byte array to an instance of the specified class.

Parameters:

bytes - The DSON encoded object to deserialize

valueType - The class of the object to deserialize

Returns:

The deserialized object

Throws:

SerializationException - if something goes wrong with serialization

fromDson

public <T> T fromDson(byte[] bytes,
                      DsonJavaType valueType)
               throws SerializationException

Convert the specified DSON encoded byte array to an instance of the specified class.

Parameters:

bytes - The DSON encoded object to deserialize

valueType - The class of the object to deserialize

Returns:

The deserialized object

Throws:

SerializationException - if something goes wrong with serialization

fromJson

public <T> T fromJson(java.lang.String json,
                      java.lang.Class<T> valueType)
               throws SerializationException

Convert the specified JSON encoded string to an instance of the specified class.

Parameters:

json - The JSON encoded object to deserialize

valueType - The class of the object to deserialize

Returns:

The deserialized object

Throws:

SerializationException - if something goes wrong with serialization

fromJson

public <T> T fromJson(java.lang.String json,
                      JsonJavaType valueType)
               throws SerializationException

Convert the specified JSON encoded string to an instance of the specified class.

Parameters:

json - The JSON encoded object to deserialize

valueType - The class of the object to deserialize

Returns:

The deserialized object

Throws:

SerializationException - if something goes wrong with serialization

fromJsonObject

public <T> T fromJsonObject(org.json.JSONObject json,
                            java.lang.Class<T> valueType)

Convert the specified JSONObject to an instance of the specified class.

Parameters:

json - The JSONObject object to convert

valueType - The class of the object to convert to

Returns:

The converted object

dsonCollectionType

public DsonJavaType dsonCollectionType(java.lang.Class<? extends java.util.Collection> collectionClass,
                                       java.lang.Class<?> elementClass)

Return a collection type for use with the fromDson(byte[], DsonJavaType) method.

Parameters:

collectionClass - The collection class to deserialize.

elementClass - The collection element type.

Returns:

The deserialized collection.

jsonCollectionType

public JsonJavaType jsonCollectionType(java.lang.Class<? extends java.util.Collection> collectionClass,
                                       java.lang.Class<?> elementClass)

Return a collection type for use with the fromJson(String, JsonJavaType) method.

Parameters:

collectionClass - The collection class to deserialize.

elementClass - The collection element type.

Returns:

The deserialized collection.

getIdForClass

public java.lang.String getIdForClass(java.lang.Class<?> cls)

Retrieve serializer ID from class.

Parameters:

cls - The class to look up the ID for

Returns:

The serializer ID, or null if no serializer for the specified class.

getClassForId

public java.lang.Class<?> getClassForId(java.lang.String id)

Retrieve class given a serializer ID.

Parameters:

id - The ID to look up the class for

Returns:

The class, or null if serializer ID unknown.