Top Description Inners Fields Constructors Methods
com.fasterxml.jackson.databind.deser.std

public Class MapDeserializer

extends ContainerDeserializerBase<Map<Object, Object>>
implements ContextualDeserializer, ResolvableDeserializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.deser.ResolvableDeserializer, com.fasterxml.jackson.databind.deser.ContextualDeserializer
Annotations
@JacksonStdImpl
Imports
java.io.IOException, java.util.*, com.fasterxml.jackson.annotation.JsonIgnoreProperties, .JsonIncludeProperties, com.fasterxml.jackson.core.*, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.annotation.JacksonStdImpl, com.fasterxml.jackson.databind.deser.*, com.fasterxml.jackson.databind.deser.impl.PropertyBasedCreator, .PropertyValueBuffer, .ReadableObjectId.Referring, com.fasterxml.jackson.databind.introspect.AnnotatedMember, com.fasterxml.jackson.databind.jsontype.TypeDeserializer, com.fasterxml.jackson.databind.type.LogicalType, com.fasterxml.jackson.databind.util.ArrayBuilders, .IgnorePropertiesUtil

Basic deserializer that can take JSON "Object" structure and construct a java.util.Map instance, with typed contents.

Note

for untyped content (one indicated by passing Object.class as the type), UntypedObjectDeserializer is used instead. It can also construct java.util.Maps, but not with specific POJO types, only other containers and primitives/wrappers.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
MapDeserializer.MapReferring

Helper class to maintain processing order of value.

private static class

Field Summary

Modifier and TypeField and Description
protected boolean
_checkDupSquash

Flag used to check, whether the com.fasterxml.jackson.core.StreamReadCapability#DUPLICATE_PROPERTIES can be applied, because the Map has declared value type of java.lang.Object.

protected JsonDeserializer<Object>
_delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

protected final boolean
protected Set<String>
protected Set<String>
protected IgnorePropertiesUtil.Checker
_inclusionChecker

Helper object used for name-based filtering

protected final KeyDeserializer
_keyDeserializer

Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved when resolve is called;

protected PropertyBasedCreator
_propertyBasedCreator

If the Map is to be instantiated using non-default constructor or factory method that takes one or more named properties as argument(s), this creator is used for instantiation.

protected boolean
_standardStringKey

Flag set to indicate that the key type is java.lang.String (or java.lang.Object, for which String is acceptable), and that the default Jackson key deserializer would be used.

protected final JsonDeserializer<Object>
_valueDeserializer

Value deserializer.

protected final ValueInstantiator
protected final TypeDeserializer
_valueTypeDeserializer

If value instances have polymorphic type information, this is the type deserializer that can handle it

private static final long
Inherited from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase:
_containerType_nullProvider_skipNullValues_unwrapSingle

Constructor Summary

AccessConstructor and Description
public
MapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)

protected
MapDeserializer(MapDeserializer src)

Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.

protected
MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable)

protected
MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)

Method Summary

Modifier and TypeMethod and Description
public Map<Object, Object>
protected final boolean
_isStdKeyDeser(JavaType mapType, KeyDeserializer keyDeser)

Helper method used to check whether we can just use the default key deserialization, where JSON String becomes Java String.

protected final Map<Object, Object>
protected final Map<Object, Object>
_readAndBindStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result)

Optimized method used when keys can be deserialized as plain old java.lang.Strings, and there is no custom deserialized specified.

protected final void
protected final void
_readAndUpdateStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result)

Optimized method used when keys can be deserialized as plain old java.lang.Strings, and there is no custom deserializer specified.

protected void
_squashDups(final DeserializationContext ctxt, final Map<Object, Object> result, final Object key, final Object oldValue, final Object newValue)

public JsonDeserializer<?>
createContextual(DeserializationContext
Deserialization context to access configuration, additional deserializers that may be needed by this deserializer
ctxt
,
BeanProperty
Method, field or constructor parameter that represents the property (and is used to assign deserialized value). 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' deserializer as is)
property
)

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.

public Map<Object, Object>
deserialize(JsonParser
Parser used for reading JSON content
p
,
DeserializationContext
Context that can be used to access information about this deserialization activity.
ctxt
)

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

public Map<Object, Object>
deserialize(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result)

Overrides com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.

public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information
typeDeserializer
)

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

public JsonDeserializer<Object>
getContentDeserializer()

Implements abstract com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

public final Class<?>
public ValueInstantiator
public JavaType
getValueType()

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getValueType.

Exact structured type this deserializer handles, if known.

private void
public boolean
isCachable()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.isCachable.

Turns out that these are expensive enough to create so that caching does make sense.

public LogicalType
logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

public void
resolve(DeserializationContext
Context to use for accessing configuration, resolving secondary deserializers
ctxt
)

Implements com.fasterxml.jackson.databind.deser.ResolvableDeserializer.resolve.

Method called after deserializer instance has been constructed (and registered as necessary by provider objects), but before it has returned it to the caller.

public void
setIgnorableProperties(String[] ignorable)
Deprecated in 2.12, remove from 3.0

public void
public void
protected MapDeserializer
withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable)

Fluent factory method used to create a copy with slightly different settings.

protected MapDeserializer
withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)

Inherited from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase:
findBackReferencegetContentTypegetEmptyAccessPatterngetEmptyValuesupportsUpdatewrapAndThrowwrapAndThrow

Field Detail

_checkDupSquashback to summary
protected boolean _checkDupSquash

Flag used to check, whether the com.fasterxml.jackson.core.StreamReadCapability#DUPLICATE_PROPERTIES can be applied, because the Map has declared value type of java.lang.Object.

Since
2.14
_delegateDeserializerback to summary
protected JsonDeserializer<Object> _delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

_hasDefaultCreatorback to summary
protected final boolean _hasDefaultCreator
_ignorablePropertiesback to summary
protected Set<String> _ignorableProperties
_includablePropertiesback to summary
protected Set<String> _includableProperties
Since
2.12
_inclusionCheckerback to summary
protected IgnorePropertiesUtil.Checker _inclusionChecker

Helper object used for name-based filtering

Since
2.12
_keyDeserializerback to summary
protected final KeyDeserializer _keyDeserializer

Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved when resolve is called;

_propertyBasedCreatorback to summary
protected PropertyBasedCreator _propertyBasedCreator

If the Map is to be instantiated using non-default constructor or factory method that takes one or more named properties as argument(s), this creator is used for instantiation.

_standardStringKeyback to summary
protected boolean _standardStringKey

Flag set to indicate that the key type is java.lang.String (or java.lang.Object, for which String is acceptable), and that the default Jackson key deserializer would be used. If both are true, can optimize handling.

_valueDeserializerback to summary
protected final JsonDeserializer<Object> _valueDeserializer

Value deserializer.

_valueInstantiatorback to summary
protected final ValueInstantiator _valueInstantiator
_valueTypeDeserializerback to summary
protected final TypeDeserializer _valueTypeDeserializer

If value instances have polymorphic type information, this is the type deserializer that can handle it

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.deser.std.StdDeserializer.serialVersionUID.

Constructor Detail

MapDeserializerback to summary
public MapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)
MapDeserializerback to summary
protected MapDeserializer(MapDeserializer src)

Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.

MapDeserializerback to summary
protected MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable)
MapDeserializerback to summary
protected MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)
Since
2.12

Method Detail

_deserializeUsingCreatorback to summary
public Map<Object, Object> _deserializeUsingCreator(JsonParser p, DeserializationContext ctxt) throws IOException
Annotations
@SuppressWarnings:unchecked
_isStdKeyDeserback to summary
protected final boolean _isStdKeyDeser(JavaType mapType, KeyDeserializer keyDeser)

Helper method used to check whether we can just use the default key deserialization, where JSON String becomes Java String.

_readAndBindback to summary
protected final Map<Object, Object> _readAndBind(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException
_readAndBindStringKeyMapback to summary
protected final Map<Object, Object> _readAndBindStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException

Optimized method used when keys can be deserialized as plain old java.lang.Strings, and there is no custom deserialized specified.

_readAndUpdateback to summary
protected final void _readAndUpdate(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException
Since
2.9
_readAndUpdateStringKeyMapback to summary
protected final void _readAndUpdateStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException

Optimized method used when keys can be deserialized as plain old java.lang.Strings, and there is no custom deserializer specified.

Since
2.9
_squashDupsback to summary
protected void _squashDups(final DeserializationContext ctxt, final Map<Object, Object> result, final Object key, final Object oldValue, final Object newValue)
Annotations
@SuppressWarnings:unchecked
Since
2.14
createContextualback to summary
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.

Parameters
ctxt:DeserializationContext

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property:BeanProperty

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method, field or constructor parameter that represents the property (and is used to assign deserialized value). 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' deserializer as is)

Returns:JsonDeserializer<?>

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Annotations
@Override
deserializeback to summary
public Map<Object, Object> deserialize(JsonParser p, DeserializationContext ctxt) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. Returned instance is to be constructed by method itself.

Pre-condition for this method is that the parser points to the first event that is part of value to deserializer (and which is never JSON 'null' literal, more on this below): for simple types it may be the only value; and for structured types the Object start marker or a FIELD_NAME.

The two possible input conditions for structured types result from polymorphism via fields. In the ordinary case, Jackson calls this method when it has encountered an OBJECT_START, and the method implementation must advance to the next token to see the first field name. If the application configures polymorphism via a field, then the object looks like the following.

      {
          "@class": "class name",
          ...
      }
  
Jackson consumes the two tokens (the @class field name and its value) in order to learn the class and select the deserializer. Thus, the stream is pointing to the FIELD_NAME for the first field after the @class. Thus, if you want your method to work correctly both with and without polymorphism, you must begin your method with:
       if (p.currentToken() == JsonToken.START_OBJECT) {
         p.nextToken();
       }
  
This results in the stream pointing to the field name, so that the two conditions align.

Post-condition is that the parser will point to the last event that is part of deserialized value (or in case deserialization fails, event that was not recognized or usable, which may be the same event as the one it pointed to upon call).

Handling null values (JsonToken.VALUE_NULL)
: Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the JsonDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override JsonDeserializer#getNullValue(DeserializationContext) and usually also JsonDeserializer#getNullAccessPattern().

Parameters
p:JsonParser

Parser used for reading JSON content

ctxt:DeserializationContext

Context that can be used to access information about this deserialization activity.

Returns:Map<Object, Object>

Deserialized value

Annotations
@Override
@SuppressWarnings:unchecked
deserializeback to summary
public Map<Object, Object> deserialize(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException

Overrides com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer. Method is not necessarily used (or supported) by all types (it will not work for immutable types, for obvious reasons): most commonly it is used for Collections and Maps. It may be used both with "updating readers" (for POJOs) and when Collections and Maps use "getter as setter".

Default implementation just throws UnsupportedOperationException, to indicate that types that do not explicitly add support do not necessarily support update-existing-value operation (esp. immutable types)

Annotations
@SuppressWarnings:unchecked
@Override
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Doc from com.fasterxml.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.

Parameters
typeDeserializer:TypeDeserializer

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType.

Deserializer to use for handling type information

Annotations
@Override
getContentDeserializerback to summary
public JsonDeserializer<Object> getContentDeserializer()

Implements abstract com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Doc from com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

Annotations
@Override
getMapClassback to summary
public final Class<?> getMapClass()
Annotations
@SuppressWarnings:unchecked
getValueInstantiatorback to summary
public ValueInstantiator getValueInstantiator()

Overrides com.fasterxml.jackson.databind.deser.std.StdDeserializer.getValueInstantiator.

Implements com.fasterxml.jackson.databind.deser.ValueInstantiator.Gettable.getValueInstantiator.

Annotations
@Override
getValueTypeback to summary
public JavaType getValueType()

Overrides com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase.getValueType.

Doc from com.fasterxml.jackson.databind.deser.std.StdDeserializer.getValueType.

Exact structured type this deserializer handles, if known.

Annotations
@Override
handleUnresolvedReferenceback to summary
private void handleUnresolvedReference(DeserializationContext ctxt, MapDeserializer.MapReferringAccumulator accumulator, Object key, UnresolvedForwardReference reference) throws JsonMappingException
isCachableback to summary
public boolean isCachable()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.isCachable.

Turns out that these are expensive enough to create so that caching does make sense.

Important Note

but, note, that instances CAN NOT BE CACHED if there is a value type deserializer; this caused an issue with 2.4.4 of JAXB Annotations (failing a test). It is also possible that some other settings could make deserializers un-cacheable; but on the other hand, caching can make a big positive difference with performance... so it's a hard choice.

Annotations
@Override
Since
2.4.4
logicalTypeback to summary
public LogicalType logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces. Typically used for further configuring handling of values, for example, to find which coercions are legal.

Returns:LogicalType

Logical type of values this deserializer produces, if known; null if not

Annotations
@Override
resolveback to summary
public void resolve(DeserializationContext ctxt) throws JsonMappingException

Implements com.fasterxml.jackson.databind.deser.ResolvableDeserializer.resolve.

Doc from com.fasterxml.jackson.databind.deser.ResolvableDeserializer.resolve.

Method called after deserializer instance has been constructed (and registered as necessary by provider objects), but before it has returned it to the caller. Called object can then resolve its dependencies to other types, including self-references (direct or indirect).

Parameters
ctxt:DeserializationContext

Context to use for accessing configuration, resolving secondary deserializers

Annotations
@Override
setIgnorablePropertiesback to summary
public void setIgnorableProperties(String[] ignorable)

Deprecated

in 2.12, remove from 3.0

Annotations
@Deprecated
setIgnorablePropertiesback to summary
public void setIgnorableProperties(Set<String> ignorable)
setIncludablePropertiesback to summary
public void setIncludableProperties(Set<String> includable)
withResolvedback to summary
protected MapDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable)

Fluent factory method used to create a copy with slightly different settings. When sub-classing, MUST be overridden.

withResolvedback to summary
protected MapDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)
Annotations
@SuppressWarnings:unchecked
Since
2.12
com.fasterxml.jackson.databind.deser.std back to summary

pack-priv Class MapDeserializer.MapReferring

extends Referring
Class Inheritance

Helper class to maintain processing order of value. The resolved object associated with key comes before the values in next.

Field Summary

Modifier and TypeField and Description
private final MapDeserializer.MapReferringAccumulator
public final Object
public final Map<Object, Object>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public void
Inherited from com.fasterxml.jackson.databind.deser.impl.ReadableObjectId.Referring:
getBeanTypegetLocationhasId

Field Detail

_parentback to summary
private final MapDeserializer.MapReferringAccumulator _parent
keyback to summary
public final Object key
nextback to summary
public final Map<Object, Object> next

Constructor Detail

MapReferringback to summary
pack-priv MapReferring(MapDeserializer.MapReferringAccumulator parent, UnresolvedForwardReference ref, Class<?> valueType, Object key)

Method Detail

handleResolvedForwardReferenceback to summary
public void handleResolvedForwardReference(Object id, Object value) throws IOException

Implements abstract com.fasterxml.jackson.databind.deser.impl.ReadableObjectId.Referring.handleResolvedForwardReference.

Annotations
@Override
com.fasterxml.jackson.databind.deser.std back to summary

private final Class MapDeserializer.MapReferringAccumulator

extends Object
Class Inheritance
  • java.lang.Object
  • com.fasterxml.jackson.databind.deser.std.MapDeserializer.MapReferringAccumulator

Field Summary

Modifier and TypeField and Description
private List<MapDeserializer.MapReferring>
_accumulator

A list of MapReferring to maintain ordering.

private Map<Object, Object>
private final Class<?>

Constructor Summary

AccessConstructor and Description
public
MapReferringAccumulator(Class<?> valueType, Map<Object, Object> result)

Method Summary

Modifier and TypeMethod and Description
public ReadableObjectId.Referring
public void
put(Object key, Object value)

public void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_accumulatorback to summary
private List<MapDeserializer.MapReferring> _accumulator

A list of MapReferring to maintain ordering.

_resultback to summary
private Map<Object, Object> _result
_valueTypeback to summary
private final Class<?> _valueType

Constructor Detail

MapReferringAccumulatorback to summary
public MapReferringAccumulator(Class<?> valueType, Map<Object, Object> result)

Method Detail

handleUnresolvedReferenceback to summary
public ReadableObjectId.Referring handleUnresolvedReference(UnresolvedForwardReference reference, Object key)
putback to summary
public void put(Object key, Object value)
resolveForwardReferenceback to summary
public void resolveForwardReference(Object id, Object value) throws IOException