net.lecousin.framework.io.serialization.rules

Interface SerializationRule

All Known Implementing Classes:

AbstractAttributeInstantiation, AddAttributeToType, AttributeInstantiation, CustomAttributeSerializer, CustomTypeSerializer, IgnoreAttribute, MergeTypeAttributes, RenameAttribute, TypeFactory

public interface SerializationRule

Interface for a serialization rule.

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.
default boolean	canInstantiate(TypeDefinition type, SerializationContext context) During deserialization, when a type needs to be instantiated, this method is called to know if this rule is providing a custom way to instantiate the given type.
default 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.
default 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.
default 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.
default Object	instantiate(TypeDefinition type, SerializationContext context) Called if the method canInstantiate previously returned true during deserialization.
boolean	isEquivalent(SerializationRule rule) Check if this rule is equivalent to the given rule.
default void	onInstantiation(TypeDefinition type, Object instance, SerializationContext context) Called each time a type is instantiated during deserialization.

Method Detail

apply

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

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

Throws:

SerializationException

isEquivalent

boolean isEquivalent(SerializationRule rule)

Check if this rule is equivalent to the given rule.

convertSerializationValue

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

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

Throws:

SerializationException

getDeserializationType

default 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. This is also used for writing serialization specification.

getDeserializationValue

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

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

Throws:

SerializationException

canInstantiate

default boolean canInstantiate(TypeDefinition type,
                               SerializationContext context)

During deserialization, when a type needs to be instantiated, this method is called to know if this rule is providing a custom way to instantiate the given type.

instantiate

default Object instantiate(TypeDefinition type,
                           SerializationContext context)
                    throws SerializationException

Called if the method canInstantiate previously returned true during deserialization.

Throws:

SerializationException

onInstantiation

default void onInstantiation(TypeDefinition type,
                             Object instance,
                             SerializationContext context)
                      throws SerializationException

Called each time a type is instantiated during deserialization.

Throws:

SerializationException