org.eth.cyril.util.serialization

Class ObjectSerializer

java.lang.Object

org.eth.cyril.util.serialization.ObjectSerializer

public class ObjectSerializer
extends java.lang.Object

An object serializer which serializes entire objects, by serializing each of the fields separately. Even though this class is called "Serializer", it does not implement the serializer interface. Essentially, this is the class which should be used for simplification of the JsonSerializable.toJson() and JsonSerializable.fromJson(JsonValue) methods, which then need only a single line of code, where they call the appropriate methods, using an appropriate Serializer to serialize the fields. See also Serialization for often used methods.

Constructor Summary

Constructors

Constructor and Description
ObjectSerializer(Serializer fieldSerializer)

Method Summary

Modifier and Type	Method and Description
void	loadFromJson(java.lang.Object object, javax.json.JsonValue json, java.util.List<java.lang.reflect.Field> fieldsToRestore) Load the given object from Json, by initializing its fields according to the serialized json.
javax.json.JsonValue	toJson(java.lang.Object object, java.util.List<java.lang.reflect.Field> fieldsToStore) Creates a JsonObject for the given object, where the object is persisted by mapping each of the fields to their values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectSerializer

public ObjectSerializer(Serializer fieldSerializer)

Method Detail

toJson

public javax.json.JsonValue toJson(java.lang.Object object,
                                   java.util.List<java.lang.reflect.Field> fieldsToStore)

Creates a JsonObject for the given object, where the object is persisted by mapping each of the fields to their values. Fields are only persisted if they are either null, or of a serializable type. Non-serializable fields of non-null values are not converted to Json. The fields which should be converted are given as a list. See Fields for various helper methods to get a list of fields.

Parameters:

object - The object to be converted to Json.

fieldsToStore - A list of fields to be stored in Json.

Returns:

A JsonValue corresponding to the converted object.

loadFromJson

public void loadFromJson(java.lang.Object object,
                         javax.json.JsonValue json,
                         java.util.List<java.lang.reflect.Field> fieldsToRestore)

Load the given object from Json, by initializing its fields according to the serialized json.

Parameters:

object - The object with the fields to be initialized.

json - The Json content describing the content of the fields.

fieldsToRestore - The fields which must be restored to their original value.