net.lecousin.framework.io.serialization.rules

Class CustomTypeSerializer

java.lang.Object

net.lecousin.framework.io.serialization.rules.CustomTypeSerializer

All Implemented Interfaces:

SerializationRule

public class CustomTypeSerializer
extends Object
implements SerializationRule

Rule that specifies a custom serializer. It can be applied to a specific attribute only by specifying a OnClassAttribute context, to a class only by specifying a OnClass context, or generally by not specifying a context. Each time an attribute is found with the same type as the custom serializer's sourceType, and the context matches, the custom serializer will be used instead of the default one.

Constructor Summary

Constructors

Constructor and Description
CustomTypeSerializer(CustomSerializer serializer, SerializationContextPattern context) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	apply(SerializationClass type, SerializationContext context, List<SerializationRule> rules, boolean serializing) Apply the rule to the given type, knowing the given context.
Object	convertSerializationValue(Object value, TypeDefinition type, SerializationContext context) Before to serialize a value, this method is called in order to give the opportunity to convert to another value.
TypeDefinition	getDeserializationType(TypeDefinition type, SerializationContext context) Can be used to change a type during deserialization, in a similar way as the method convertSerializationValue during serialization.
Object	getDeserializationValue(Object value, TypeDefinition type, SerializationContext context) Can be used to change the deserialization, in a similar way as the method convertSerializationValue during serialization.
boolean	isEquivalent(SerializationRule rule) Check if this rule is equivalent to the given rule.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lecousin.framework.io.serialization.rules.SerializationRule

canInstantiate, instantiate, onInstantiation

Constructor Detail

CustomTypeSerializer

public CustomTypeSerializer(CustomSerializer serializer,
                            SerializationContextPattern context)

Constructor.

Method Detail

apply

public boolean apply(SerializationClass type,
                     SerializationContext context,
                     List<SerializationRule> rules,
                     boolean serializing)

Description copied from interface: SerializationRule

Apply the rule to the given type, knowing the given context. If true is returned no other rule will be applied on the type.

Specified by:

apply in interface SerializationRule

convertSerializationValue

public Object convertSerializationValue(Object value,
                                        TypeDefinition type,
                                        SerializationContext context)
                                 throws SerializationException

Description copied from interface: SerializationRule

Before to serialize a value, this method is called in order to give the opportunity to convert to another value.

Specified by:

convertSerializationValue in interface SerializationRule

Throws:

SerializationException

getDeserializationType

public TypeDefinition getDeserializationType(TypeDefinition type,
                                             SerializationContext context)

Description copied from interface: SerializationRule

Can be used to change a type during deserialization, in a similar way as the method convertSerializationValue during serialization. This is also used for writing serialization specification.

Specified by:

getDeserializationType in interface SerializationRule

getDeserializationValue

public Object getDeserializationValue(Object value,
                                      TypeDefinition type,
                                      SerializationContext context)
                               throws SerializationException

Description copied from interface: SerializationRule

Can be used to change the deserialization, in a similar way as the method convertSerializationValue during serialization.

Specified by:

getDeserializationValue in interface SerializationRule

Throws:

SerializationException

isEquivalent

public boolean isEquivalent(SerializationRule rule)

Description copied from interface: SerializationRule

Check if this rule is equivalent to the given rule.

Specified by:

isEquivalent in interface SerializationRule