com.buckosoft.PicMan.service.support

Class KeyValueMapSerializer

java.lang.Object

<any>

com.buckosoft.PicMan.service.support.KeyValueMapSerializer

All Implemented Interfaces:

MapLabels

public class KeyValueMapSerializer
extends <any>
implements MapLabels

Standard serializer implementation for serializing {link java.util.Map} types.

Note: about the only configurable setting currently is ability to filter out entries with specified names.

Field Summary

Fields

Modifier and Type	Field and Description
protected PropertySerializerMap	_dynamicValueSerializers If value type can not be statically determined, mapping from runtime value types to serializers are stored in this object.
protected java.util.HashSet<java.lang.String>	_ignoredEntries Set of entries to omit during serialization, if any
protected <any>	_keySerializer Key serializer to use, if it can be statically determined
protected JavaType	_keyType Declared type of keys
protected TypeSerializer	_keyTypeSerializer Type identifier serializer used for keys, if any.
protected BeanProperty	_property Map-valued property being serialized with this instance
protected <any>	_valueSerializer Value serializer to use, if it can be statically determined
protected JavaType	_valueType Declared type of contained values
protected boolean	_valueTypeIsStatic Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)
protected TypeSerializer	_valueTypeSerializer Type identifier serializer used for values, if any.
protected static JavaType	UNSPECIFIED_TYPE

Fields inherited from interface com.buckosoft.PicMan.service.support.MapLabels

MAP_KEY_NAME, MAP_VALUE_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyValueMapSerializer(java.util.HashSet<java.lang.String> ignoredEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer kts, TypeSerializer vts, <any> keySerializer, <any> valueSerializer)
protected	KeyValueMapSerializer(KeyValueMapSerializer src, BeanProperty property, <any> keySerializer, <any> valueSerializer, java.util.HashSet<java.lang.String> ignored)
protected	KeyValueMapSerializer(KeyValueMapSerializer src, TypeSerializer vts)

Method Summary

Modifier and Type	Method and Description
protected <any>	_findAndAddDynamic(PropertySerializerMap map, java.lang.Class<?> type, SerializerProvider provider)
protected <any>	_findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider)
protected java.util.Map<?,?>	_orderEntries(java.util.Map<?,?> input)
KeyValueMapSerializer	_withValueTypeSerializer(TypeSerializer vts)
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)
<any>	createContextual(SerializerProvider provider, BeanProperty property)
<any>	getContentSerializer()
JavaType	getContentType()
<any>	getKeySerializer() Accessor for currently assigned key serializer.
JsonNode	getSchema(SerializerProvider provider, java.lang.reflect.Type typeHint)
boolean	hasSingleElement(java.util.Map<?,?> value)
boolean	isEmpty(java.util.Map<?,?> value)
void	serialize(java.util.Map<?,?> value, JsonGenerator jgen, SerializerProvider provider)
void	serializeFields(java.util.Map<?,?> value, JsonGenerator jgen, SerializerProvider provider) Method called to serialize fields, when the value type is not statically known.
protected void	serializeFieldsUsing(java.util.Map<?,?> value, JsonGenerator jgen, SerializerProvider provider, <any> ser) Method called to serialize fields, when the value type is statically known, so that value serializer is passed and does not need to be fetched from provider.
protected void	serializeTypedFields(java.util.Map<?,?> value, JsonGenerator jgen, SerializerProvider provider)
void	serializeWithType(java.util.Map<?,?> value, JsonGenerator jgen, SerializerProvider provider, TypeSerializer typeSer)
KeyValueMapSerializer	withResolved(BeanProperty property, <any> keySerializer, <any> valueSerializer, java.util.HashSet<java.lang.String> ignored)

Methods inherited from class java.lang.Object

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

Field Detail

UNSPECIFIED_TYPE

protected static final JavaType UNSPECIFIED_TYPE

_property

protected final BeanProperty _property

Map-valued property being serialized with this instance

_ignoredEntries

protected final java.util.HashSet<java.lang.String> _ignoredEntries

Set of entries to omit during serialization, if any

_valueTypeIsStatic

protected final boolean _valueTypeIsStatic

Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)

_keyType

protected final JavaType _keyType

Declared type of keys

_valueType

protected final JavaType _valueType

Declared type of contained values

_keySerializer

protected <any> _keySerializer

Key serializer to use, if it can be statically determined

_keyTypeSerializer

protected final TypeSerializer _keyTypeSerializer

Type identifier serializer used for keys, if any.

_valueSerializer

protected <any> _valueSerializer

Value serializer to use, if it can be statically determined

_valueTypeSerializer

protected final TypeSerializer _valueTypeSerializer

Type identifier serializer used for values, if any.

_dynamicValueSerializers

protected PropertySerializerMap _dynamicValueSerializers

If value type can not be statically determined, mapping from runtime value types to serializers are stored in this object.

Constructor Detail

KeyValueMapSerializer

protected KeyValueMapSerializer(java.util.HashSet<java.lang.String> ignoredEntries,
                                JavaType keyType,
                                JavaType valueType,
                                boolean valueTypeIsStatic,
                                TypeSerializer kts,
                                TypeSerializer vts,
                                <any> keySerializer,
                                <any> valueSerializer)

KeyValueMapSerializer

protected KeyValueMapSerializer(KeyValueMapSerializer src,
                                BeanProperty property,
                                <any> keySerializer,
                                <any> valueSerializer,
                                java.util.HashSet<java.lang.String> ignored)

KeyValueMapSerializer

protected KeyValueMapSerializer(KeyValueMapSerializer src,
                                TypeSerializer vts)

Method Detail

_withValueTypeSerializer

public KeyValueMapSerializer _withValueTypeSerializer(TypeSerializer vts)

withResolved

public KeyValueMapSerializer withResolved(BeanProperty property,
                                          <any> keySerializer,
                                          <any> valueSerializer,
                                          java.util.HashSet<java.lang.String> ignored)

createContextual

public <any> createContextual(SerializerProvider provider,
                              BeanProperty property)
                       throws JsonMappingException

Throws:

JsonMappingException

getContentType

public JavaType getContentType()

getContentSerializer

public <any> getContentSerializer()

isEmpty

public boolean isEmpty(java.util.Map<?,?> value)

hasSingleElement

public boolean hasSingleElement(java.util.Map<?,?> value)

getKeySerializer

public <any> getKeySerializer()

Accessor for currently assigned key serializer. Note that this may return null during construction of MapSerializer: depedencies are resolved during createContextual(SerializerProvider, BeanProperty) method (which can be overridden by custom implementations), but for some dynamic types, it is possible that serializer is only resolved during actual serialization.

Since:

2.0

serialize

public void serialize(java.util.Map<?,?> value,
                      JsonGenerator jgen,
                      SerializerProvider provider)
               throws java.io.IOException,
                      JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

serializeWithType

public void serializeWithType(java.util.Map<?,?> value,
                              JsonGenerator jgen,
                              SerializerProvider provider,
                              TypeSerializer typeSer)
                       throws java.io.IOException,
                              JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

serializeFields

public void serializeFields(java.util.Map<?,?> value,
                            JsonGenerator jgen,
                            SerializerProvider provider)
                     throws java.io.IOException,
                            JsonGenerationException

Method called to serialize fields, when the value type is not statically known.

Throws:

java.io.IOException

JsonGenerationException

serializeFieldsUsing

protected void serializeFieldsUsing(java.util.Map<?,?> value,
                                    JsonGenerator jgen,
                                    SerializerProvider provider,
                                    <any> ser)
                             throws java.io.IOException,
                                    JsonGenerationException

Method called to serialize fields, when the value type is statically known, so that value serializer is passed and does not need to be fetched from provider.

Throws:

java.io.IOException

JsonGenerationException

serializeTypedFields

protected void serializeTypedFields(java.util.Map<?,?> value,
                                    JsonGenerator jgen,
                                    SerializerProvider provider)
                             throws java.io.IOException,
                                    JsonGenerationException

Throws:

java.io.IOException

JsonGenerationException

getSchema

public JsonNode getSchema(SerializerProvider provider,
                          java.lang.reflect.Type typeHint)

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
                                    JavaType typeHint)
                             throws JsonMappingException

Throws:

JsonMappingException

_findAndAddDynamic

protected final <any> _findAndAddDynamic(PropertySerializerMap map,
                                         java.lang.Class<?> type,
                                         SerializerProvider provider)
                                  throws JsonMappingException

Throws:

JsonMappingException

_findAndAddDynamic

protected final <any> _findAndAddDynamic(PropertySerializerMap map,
                                         JavaType type,
                                         SerializerProvider provider)
                                  throws JsonMappingException

Throws:

JsonMappingException

_orderEntries

protected java.util.Map<?,?> _orderEntries(java.util.Map<?,?> input)