Class MapSerializer
- All Implemented Interfaces:
JsonFormatVisitable
,SchemaAware
,ContextualSerializer
,Serializable
Note: about the only configurable setting currently is ability to filter out entries with specified names.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
JsonSerializer.None
-
Field Summary
Modifier and TypeFieldDescriptionprotected PropertySerializerMap
If value type cannot be statically determined, mapping from runtime value types to serializers are stored in this object.protected final Object
Id of the property filter to use, if any; null if none.Set of entries to omit during serialization, if anySet of entries to include during serialization, if null, it is ignored, empty will include nothing.protected final IgnorePropertiesUtil.Checker
Helper object used for name-based filteringprotected JsonSerializer<Object>
Key serializer to use, if it can be statically determinedprotected final JavaType
Declared type of keysprotected final BeanProperty
Map-valued property being serialized with this instanceprotected final boolean
Flag set if output is forced to be sorted by keys (usually due to annotation).protected final Object
Value that indicates suppression mechanism to use for values contained; either "filter" (of whichequals()
is called), or marker value ofMARKER_FOR_EMPTY
, or null to indicate no filtering for non-null values.protected final boolean
Flag that indicates what to do with `null` values, distinct from handling of_suppressableValue
protected JsonSerializer<Object>
Value serializer to use, if it can be statically determinedprotected final JavaType
Declared type of contained valuesprotected final boolean
Whether static types should be used for serialization of values or not (if not, dynamic runtime type is used)protected final TypeSerializer
Type identifier serializer used for values, if any.static final Object
protected static final JavaType
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_handledType
-
Constructor Summary
ModifierConstructorDescriptionprotected
MapSerializer
(MapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignoredEntries) Deprecated.in 2.12, remove from 3.0protected
MapSerializer
(MapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignoredEntries, Set<String> includedEntries) protected
MapSerializer
(MapSerializer src, TypeSerializer vts, Object suppressableValue) Deprecated.// since 2.9protected
MapSerializer
(MapSerializer src, TypeSerializer vts, Object suppressableValue, boolean suppressNulls) protected
MapSerializer
(MapSerializer src, Object filterId, boolean sortKeys) protected
MapSerializer
(Set<String> ignoredEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer) Deprecated.in 2.12, remove from 3.0protected
MapSerializer
(Set<String> ignoredEntries, Set<String> includedEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Deprecated.protected void
_ensureOverride
(String method) protected final JsonSerializer<Object>
_findAndAddDynamic
(PropertySerializerMap map, JavaType type, SerializerProvider provider) protected final JsonSerializer<Object>
_findAndAddDynamic
(PropertySerializerMap map, Class<?> type, SerializerProvider provider) protected boolean
_hasNullKey
(Map<?, ?> input) protected Map<?,
?> _orderEntries
(Map<?, ?> input, JsonGenerator gen, SerializerProvider provider) Method that needs to be implemented to allow construction of a new serializer object with givenTypeSerializer
, used when addition type information is to be embedded.protected void
_writeNullKeyedEntry
(JsonGenerator gen, SerializerProvider provider, Object value) void
acceptJsonFormatVisitor
(JsonFormatVisitorWrapper visitor, JavaType typeHint) Default implementation specifies no format.static MapSerializer
construct
(String[] ignoredList, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId) Deprecated.Since 2.8 use the other overloadstatic MapSerializer
construct
(Set<String> ignoredEntries, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId) static MapSerializer
construct
(Set<String> ignoredEntries, Set<String> includedEntries, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId) createContextual
(SerializerProvider provider, BeanProperty property) Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically.Accessor for finding declared (static) element type for type this serializer is used for.Accessor for currently assigned key serializer.getSchema
(SerializerProvider provider, Type typeHint) Default implementation simply claims type is "string"; usually overriden by custom serializers.boolean
hasSingleElement
(Map<?, ?> value) Method called to determine if the given value (of type handled by this serializer) contains exactly one element.boolean
isEmpty
(SerializerProvider prov, Map<?, ?> value) Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).void
serialize
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider) Method that can be called to ask implementation to serialize values of type this serializer handles.void
serializeFields
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider) General-purpose serialization for contents, where we do not necessarily know the value serialization, but we do know that no value suppression is needed (which simplifies processing a bit)void
serializeFieldsUsing
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, JsonSerializer<Object> 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.void
serializeFilteredAnyProperties
(SerializerProvider provider, JsonGenerator gen, Object bean, Map<?, ?> value, PropertyFilter filter, Object suppressableValue) Helper method used when we have a JSON Filter to use AND contents are "any properties" of a POJO.void
serializeFilteredFields
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, PropertyFilter filter, Object suppressableValue) Helper method used when we have a JSON Filter to use for potentially filtering out Map entries.void
serializeOptionalFields
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, Object suppressableValue) Serialization method called when exclusion filtering needs to be applied.void
serializeTypedFields
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, Object suppressableValue) void
serializeWithoutTypeInfo
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider) General-purpose serialization for contents without writing object type.void
serializeWithType
(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.withContentInclusion
(Object suppressableValue) Deprecated.since 2.9withContentInclusion
(Object suppressableValue, boolean suppressNulls) Mutant factory for constructing an instance with different inclusion strategy for content (Map values).withFilterId
(Object filterId) Mutant factory method that is called if contextual configuration indicates that a specific filter (as specified byfilterId
) is to be used for serialization.withResolved
(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignored, boolean sortKeys) withResolved
(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignored, Set<String> included, boolean sortKeys) Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.ContainerSerializer
hasContentTypeAnnotation, withValueTypeSerializer
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.ser.std.StdSerializer
_neitherNull, _nonEmpty, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonSerializer
getDelegatee, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, unwrappingSerializer, usesObjectId
-
Field Details
-
UNSPECIFIED_TYPE
-
MARKER_FOR_EMPTY
- Since:
- 2.9
-
_property
Map-valued property being serialized with this instance -
_valueTypeIsStatic
protected final boolean _valueTypeIsStaticWhether static types should be used for serialization of values or not (if not, dynamic runtime type is used) -
_keyType
Declared type of keys -
_valueType
Declared type of contained values -
_keySerializer
Key serializer to use, if it can be statically determined -
_valueSerializer
Value serializer to use, if it can be statically determined -
_valueTypeSerializer
Type identifier serializer used for values, if any. -
_dynamicValueSerializers
If value type cannot be statically determined, mapping from runtime value types to serializers are stored in this object. -
_ignoredEntries
Set of entries to omit during serialization, if any -
_includedEntries
Set of entries to include during serialization, if null, it is ignored, empty will include nothing.- Since:
- 2.12
-
_filterId
Id of the property filter to use, if any; null if none.- Since:
- 2.3
-
_suppressableValue
Value that indicates suppression mechanism to use for values contained; either "filter" (of whichequals()
is called), or marker value ofMARKER_FOR_EMPTY
, or null to indicate no filtering for non-null values. Note that inclusion value for Map instance itself is handled by caller (POJO property that refers to the Map value).- Since:
- 2.5
-
_suppressNulls
protected final boolean _suppressNullsFlag that indicates what to do with `null` values, distinct from handling of_suppressableValue
- Since:
- 2.9
-
_inclusionChecker
Helper object used for name-based filtering- Since:
- 2.12
-
_sortKeys
protected final boolean _sortKeysFlag set if output is forced to be sorted by keys (usually due to annotation).- Since:
- 2.4
-
-
Constructor Details
-
MapSerializer
protected MapSerializer(Set<String> ignoredEntries, Set<String> includedEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer) - Since:
- 2.12
-
MapSerializer
@Deprecated protected MapSerializer(Set<String> ignoredEntries, JavaType keyType, JavaType valueType, boolean valueTypeIsStatic, TypeSerializer vts, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer) Deprecated.in 2.12, remove from 3.0- Since:
- 2.5
-
MapSerializer
protected MapSerializer(MapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignoredEntries, Set<String> includedEntries) - Since:
- 2.12
-
MapSerializer
@Deprecated protected MapSerializer(MapSerializer src, BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignoredEntries) Deprecated.in 2.12, remove from 3.0 -
MapSerializer
protected MapSerializer(MapSerializer src, TypeSerializer vts, Object suppressableValue, boolean suppressNulls) - Since:
- 2.9
-
MapSerializer
-
MapSerializer
@Deprecated protected MapSerializer(MapSerializer src, TypeSerializer vts, Object suppressableValue) Deprecated.// since 2.9- Since:
- 2.5
-
-
Method Details
-
_withValueTypeSerializer
Description copied from class:ContainerSerializer
Method that needs to be implemented to allow construction of a new serializer object with givenTypeSerializer
, used when addition type information is to be embedded.- Specified by:
_withValueTypeSerializer
in classContainerSerializer<Map<?,
?>>
-
withResolved
public MapSerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignored, Set<String> included, boolean sortKeys) - Since:
- 2.12
-
withResolved
public MapSerializer withResolved(BeanProperty property, JsonSerializer<?> keySerializer, JsonSerializer<?> valueSerializer, Set<String> ignored, boolean sortKeys) - Since:
- 2.4
-
withFilterId
Description copied from class:JsonSerializer
Mutant factory method that is called if contextual configuration indicates that a specific filter (as specified byfilterId
) is to be used for serialization.Default implementation simply returns
this
; sub-classes that do support filtering will need to create and return new instance if filter changes.- Overrides:
withFilterId
in classJsonSerializer<Map<?,
?>>
-
withContentInclusion
Mutant factory for constructing an instance with different inclusion strategy for content (Map values).- Since:
- 2.9
-
construct
public static MapSerializer construct(Set<String> ignoredEntries, Set<String> includedEntries, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId) - Since:
- 2.12
-
construct
public static MapSerializer construct(Set<String> ignoredEntries, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId) - Since:
- 2.8
-
_ensureOverride
- Since:
- 2.9
-
_ensureOverride
Deprecated.- Since:
- 2.5
-
withContentInclusion
Deprecated.since 2.9 -
construct
@Deprecated public static MapSerializer construct(String[] ignoredList, JavaType mapType, boolean staticValueType, TypeSerializer vts, JsonSerializer<Object> keySerializer, JsonSerializer<Object> valueSerializer, Object filterId) Deprecated.Since 2.8 use the other overload- Since:
- 2.3
-
createContextual
public JsonSerializer<?> createContextual(SerializerProvider provider, BeanProperty property) throws JsonMappingException Description copied from interface:ContextualSerializer
Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.- Specified by:
createContextual
in interfaceContextualSerializer
- Parameters:
provider
- Serializer provider to use for accessing config, other serializersproperty
- Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)- Returns:
- Serializer to use for serializing values of specified property; may be this instance or a new instance.
- Throws:
JsonMappingException
-
getContentType
Description copied from class:ContainerSerializer
Accessor for finding declared (static) element type for type this serializer is used for.- Specified by:
getContentType
in classContainerSerializer<Map<?,
?>>
-
getContentSerializer
Description copied from class:ContainerSerializer
Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically. Note that for dynamic types this may return null; if so, caller has to instead useContainerSerializer.getContentType()
andSerializerProvider.findContentValueSerializer(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JavaType, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanProperty)
.- Specified by:
getContentSerializer
in classContainerSerializer<Map<?,
?>>
-
isEmpty
Description copied from class:JsonSerializer
Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).Default implementation will consider only null values to be empty.
NOTE: replaces
JsonSerializer.isEmpty(Object)
, which was deprecated in 2.5- Overrides:
isEmpty
in classJsonSerializer<Map<?,
?>>
-
hasSingleElement
Description copied from class:ContainerSerializer
Method called to determine if the given value (of type handled by this serializer) contains exactly one element.Note: although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).
Note, too, that as of now (2.9) this method is only called by serializer itself; and specifically is not used for non-array/collection types like
Map
orMap.Entry
instances.- Specified by:
hasSingleElement
in classContainerSerializer<Map<?,
?>>
-
getKeySerializer
Accessor for currently assigned key serializer. Note that this may return null during construction ofMapSerializer
: depedencies are resolved duringcreateContextual(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.SerializerProvider, edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.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. -
serialize
public void serialize(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOExceptionDescription copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles.- Specified by:
serialize
in classStdSerializer<Map<?,
?>> - Parameters:
value
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.- Throws:
IOException
-
serializeWithType
public void serializeWithType(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, TypeSerializer typeSer) throws IOExceptionDescription copied from class:JsonSerializer
Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.Default implementation will throw
UnsupportedOperationException
to indicate that proper type handling needs to be implemented.For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:
// note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen);
and implementations for type serialized as JSON Arrays or Objects would differ slightly, asSTART-ARRAY
/END-ARRAY
andSTART-OBJECT
/END-OBJECT
pairs need to be properly handled with respect to serializing of contents.- Overrides:
serializeWithType
in classJsonSerializer<Map<?,
?>> - Parameters:
value
- Value to serialize; can not be null.gen
- Generator used to output resulting Json contentprovider
- Provider that can be used to get serializers for serializing Objects value contains, if any.typeSer
- Type serializer to use for including type information- Throws:
IOException
-
serializeWithoutTypeInfo
public void serializeWithoutTypeInfo(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOExceptionGeneral-purpose serialization for contents without writing object type. Will suppress, filter and use custom serializers.Public since it also is called by
AnyGetterWriter
.- Throws:
IOException
- Since:
- 2.11
-
serializeFields
public void serializeFields(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider) throws IOExceptionGeneral-purpose serialization for contents, where we do not necessarily know the value serialization, but we do know that no value suppression is needed (which simplifies processing a bit)- Throws:
IOException
-
serializeOptionalFields
public void serializeOptionalFields(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, Object suppressableValue) throws IOExceptionSerialization method called when exclusion filtering needs to be applied.- Throws:
IOException
-
serializeFieldsUsing
public void serializeFieldsUsing(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, JsonSerializer<Object> ser) throws IOExceptionMethod 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:
IOException
-
serializeFilteredFields
public void serializeFilteredFields(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, PropertyFilter filter, Object suppressableValue) throws IOExceptionHelper method used when we have a JSON Filter to use for potentially filtering out Map entries.- Throws:
IOException
- Since:
- 2.5
-
serializeTypedFields
public void serializeTypedFields(Map<?, ?> value, JsonGenerator gen, SerializerProvider provider, Object suppressableValue) throws IOException- Throws:
IOException
- Since:
- 2.5
-
serializeFilteredAnyProperties
public void serializeFilteredAnyProperties(SerializerProvider provider, JsonGenerator gen, Object bean, Map<?, ?> value, PropertyFilter filter, Object suppressableValue) throws IOExceptionHelper method used when we have a JSON Filter to use AND contents are "any properties" of a POJO.- Parameters:
bean
- Enclosing POJO that has any-getter used to obtain "any properties"- Throws:
IOException
- Since:
- 2.9
-
getSchema
Description copied from class:StdSerializer
Default implementation simply claims type is "string"; usually overriden by custom serializers.- Specified by:
getSchema
in interfaceSchemaAware
- Overrides:
getSchema
in classStdSerializer<Map<?,
?>> - Parameters:
provider
- The serializer provider.typeHint
- A hint about the type.- Returns:
- Json-schema for this serializer.
-
acceptJsonFormatVisitor
public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) throws JsonMappingException Description copied from class:StdSerializer
Default implementation specifies no format. This behavior is usually overriden by custom serializers.- Specified by:
acceptJsonFormatVisitor
in interfaceJsonFormatVisitable
- Overrides:
acceptJsonFormatVisitor
in classStdSerializer<Map<?,
?>> typeHint
- Type of element (entity like property) being visited- Throws:
JsonMappingException
-
_findAndAddDynamic
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, Class<?> type, SerializerProvider provider) throws JsonMappingException - Throws:
JsonMappingException
-
_findAndAddDynamic
protected final JsonSerializer<Object> _findAndAddDynamic(PropertySerializerMap map, JavaType type, SerializerProvider provider) throws JsonMappingException - Throws:
JsonMappingException
-
_orderEntries
protected Map<?,?> _orderEntries(Map<?, ?> input, JsonGenerator gen, SerializerProvider provider) throws IOException- Throws:
IOException
-
_hasNullKey
- Since:
- 2.8.7
-
_writeNullKeyedEntry
protected void _writeNullKeyedEntry(JsonGenerator gen, SerializerProvider provider, Object value) throws IOException - Throws:
IOException
-