org.eth.cyril.util.serialization

Interface Serializer

All Known Implementing Classes:

ClassSerializer, CollectionSerializer, CompositeSerializer, EnumSerializer, JsonSerializableSerializer, MapSerializer, PrimitiveSerializer

public interface Serializer

The serializer interface can be implemented by classes which know how to serialize certain types of objects. They can specifiy exactly which types of objects they are capable of serializing, and then must handle both serializing and deserializing of them. See Serializers for various pre-configured serializers.

Method Summary

Modifier and Type	Method and Description
boolean	canDeserialize(javax.json.JsonValue value) Returns whether this serializer can deserialize the given JsonValue.
boolean	canSerialize(java.lang.Class<?> clazz) Returns whether this serializer can serialize the given specific class.
void	decrementLevel() Decrements the level.
java.lang.Object	fromJson(javax.json.JsonValue json) Deserializes the given Json to an object.
void	incrementLevel() Increments the level, where the level denotes how far into the structure the current serializer is.
javax.json.JsonValue	toJson(java.lang.Object object) Serializes the given object to Json.

Method Detail

canSerialize

boolean canSerialize(java.lang.Class<?> clazz)

Returns whether this serializer can serialize the given specific class.

Parameters:

clazz - The class of the object to be serialized.

Returns:

Whether this serializer can serialize the given class.

canDeserialize

boolean canDeserialize(javax.json.JsonValue value)

Returns whether this serializer can deserialize the given JsonValue.

Parameters:

value - The JsonValue to be deserialized.

Returns:

Whether this serializer can serialize the given class.

toJson

javax.json.JsonValue toJson(java.lang.Object object)

Serializes the given object to Json. The given object must be of a type which can be serialized by this class. See also canSerialize(Class)

Parameters:

object - The object to be serialized.

Returns:

The Json corresponding to the object.

fromJson

java.lang.Object fromJson(javax.json.JsonValue json)

Deserializes the given Json to an object. The given JsonValue must be deserializable by this class. See also canDeserialize(JsonValue)

Parameters:

json - The JsonValue to be deserialized

Returns:

The Json corresponding to the object.

incrementLevel

void incrementLevel()

Increments the level, where the level denotes how far into the structure the current serializer is. This can be used for example to create serializers, which stop at a fixed level. Incrementing and decrementing the level only makes sense during serialization. See also decrementLevel().

decrementLevel

void decrementLevel()

Decrements the level. See also incrementLevel().