Module tools.jackson.databind

Package tools.jackson.databind.ser

Class ValueSerializerModifier

java.lang.Object

tools.jackson.databind.ser.ValueSerializerModifier

All Implemented Interfaces:

Serializable

public abstract class ValueSerializerModifier
extends Object
implements Serializable

Abstract class that defines API for objects that can be registered (via ObjectMapper configuration process, using MapperBuilder) to participate in constructing ValueSerializer instances (including but not limited to BeanSerializers). This is typically done by modules that want alter some aspects of the typical serialization process.

Sequence in which callback methods are called is as follows:

1. After factory has collected tentative set of properties (instances of BeanPropertyWriter) is sent for modification via changeProperties(tools.jackson.databind.SerializationConfig, tools.jackson.databind.BeanDescription, java.util.List<tools.jackson.databind.ser.BeanPropertyWriter>). Changes can include removal, addition and replacement of suggested properties.
2. Resulting set of properties are ordered (sorted) by factory, as per configuration, and then orderProperties(tools.jackson.databind.SerializationConfig, tools.jackson.databind.BeanDescription, java.util.List<tools.jackson.databind.ser.BeanPropertyWriter>) is called to allow modifiers to alter ordering.
3. After all bean properties and related information is accumulated, updateBuilder(tools.jackson.databind.SerializationConfig, tools.jackson.databind.BeanDescription, tools.jackson.databind.ser.BeanSerializerBuilder) is called with builder, to allow builder state to be modified (including possibly replacing builder itself if necessary)
4. Once all bean information has been determined, factory creates default BeanSerializer instance and passes it to modifiers using modifySerializer(tools.jackson.databind.SerializationConfig, tools.jackson.databind.BeanDescription, tools.jackson.databind.ValueSerializer<?>) (or type-specic alternative modifyXxxSerializer() method), for possible modification or replacement (by any ValueSerializer instance)

Default method implementations are "no-op"s, meaning that methods are implemented but have no effect.

NOTE: In Jackson 2.x was named BeanSerializerModifier

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ValueSerializerModifier()

Method Summary

Modifier and Type	Method	Description
List<BeanPropertyWriter>	changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties)	Method called by BeanSerializerFactory with tentative set of discovered properties.
ValueSerializer<?>	modifyArraySerializer(SerializationConfig config, ArrayType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)	Method called by DeserializerFactory after it has constructed the standard serializer for given ArrayType to make it possible to either replace or augment this serializer with additional functionality.
ValueSerializer<?>	modifyCollectionLikeSerializer(SerializationConfig config, CollectionLikeType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)
ValueSerializer<?>	modifyCollectionSerializer(SerializationConfig config, CollectionType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)
ValueSerializer<?>	modifyEnumSerializer(SerializationConfig config, JavaType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)
ValueSerializer<?>	modifyKeySerializer(SerializationConfig config, JavaType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)	Method called by DeserializerFactory after it has constructed the default key serializer to use for serializing Map keys of given type.
ValueSerializer<?>	modifyMapLikeSerializer(SerializationConfig config, MapLikeType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)
ValueSerializer<?>	modifyMapSerializer(SerializationConfig config, MapType valueType, BeanDescription beanDesc, ValueSerializer<?> serializer)
ValueSerializer<?>	modifySerializer(SerializationConfig config, BeanDescription beanDesc, ValueSerializer<?> serializer)	Method called by BeanSerializerFactory after constructing default bean serializer instance with properties collected and ordered earlier.
List<BeanPropertyWriter>	orderProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties)	Method called by BeanSerializerFactory with set of properties to serialize, in default ordering (based on defaults as well as possible type annotations).
BeanSerializerBuilder	updateBuilder(SerializationConfig config, BeanDescription beanDesc, BeanSerializerBuilder builder)	Method called by BeanSerializerFactory after collecting all information regarding POJO to serialize and updating builder with it, but before constructing serializer.

Methods inherited from class java.lang.Object

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

Constructor Details

ValueSerializerModifier

public ValueSerializerModifier()

Method Details

changeProperties

public List<BeanPropertyWriter> changeProperties(SerializationConfig config,
 BeanDescription beanDesc,
 List<BeanPropertyWriter> beanProperties)

Method called by BeanSerializerFactory with tentative set of discovered properties. Implementations can add, remove or replace any of passed properties. Properties List passed as argument is modifiable, and returned List must likewise be modifiable as it may be passed to multiple registered modifiers.

orderProperties

public List<BeanPropertyWriter> orderProperties(SerializationConfig config,
 BeanDescription beanDesc,
 List<BeanPropertyWriter> beanProperties)

Method called by BeanSerializerFactory with set of properties to serialize, in default ordering (based on defaults as well as possible type annotations). Implementations can change ordering any way they like. Properties List passed as argument is modifiable, and returned List must likewise be modifiable as it may be passed to multiple registered modifiers.

updateBuilder

public BeanSerializerBuilder updateBuilder(SerializationConfig config,
 BeanDescription beanDesc,
 BeanSerializerBuilder builder)

Method called by BeanSerializerFactory after collecting all information regarding POJO to serialize and updating builder with it, but before constructing serializer. Implementations may choose to modify state of builder (to affect serializer being built), or even completely replace it (if they want to build different kind of serializer). Typically, however, passed-in builder is returned, possibly with some modifications.

modifySerializer

public ValueSerializer<?> modifySerializer(SerializationConfig config,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

Method called by BeanSerializerFactory after constructing default bean serializer instance with properties collected and ordered earlier. Implementations can modify or replace given serializer and return serializer to use. Note that although initial serializer being passed is of type BeanSerializer, modifiers may return serializers of other types; and this is why implementations must check for type before casting.

NOTE: this method gets called for serializer of those non-POJO types that do not go through any of more specific modifyXxxSerializer methods; mostly for JDK types like Iterator and such.

modifyArraySerializer

public ValueSerializer<?> modifyArraySerializer(SerializationConfig config,
 ArrayType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

Method called by DeserializerFactory after it has constructed the standard serializer for given ArrayType to make it possible to either replace or augment this serializer with additional functionality.

Parameters:

config - Configuration in use

valueType - Type of the value serializer is used for.

beanDesc - Details of the type in question, to allow checking class annotations

serializer - Default serializer that would be used.

Returns:

Serializer to use; either serializer that was passed in, or an instance method constructed.

modifyCollectionSerializer

public ValueSerializer<?> modifyCollectionSerializer(SerializationConfig config,
 CollectionType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

modifyCollectionLikeSerializer

public ValueSerializer<?> modifyCollectionLikeSerializer(SerializationConfig config,
 CollectionLikeType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

modifyMapSerializer

public ValueSerializer<?> modifyMapSerializer(SerializationConfig config,
 MapType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

modifyMapLikeSerializer

public ValueSerializer<?> modifyMapLikeSerializer(SerializationConfig config,
 MapLikeType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

modifyEnumSerializer

public ValueSerializer<?> modifyEnumSerializer(SerializationConfig config,
 JavaType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

modifyKeySerializer

public ValueSerializer<?> modifyKeySerializer(SerializationConfig config,
 JavaType valueType,
 BeanDescription beanDesc,
 ValueSerializer<?> serializer)

Method called by DeserializerFactory after it has constructed the default key serializer to use for serializing Map keys of given type. This makes it possible to either replace or augment default serializer with additional functionality.

Parameters:

config - Configuration in use

valueType - Type of keys the serializer is used for.

beanDesc - Details of the type in question, to allow checking class annotations

serializer - Default serializer that would be used.

Returns:

Serializer to use; either serializer that was passed in, or an instance method constructed.