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.s, but not with specific
POJO types, only other containers and primitives/wrappers.
| Modifier and Type | Class and Description |
|---|---|
| pack-priv static class | MapDeserializer.
Helper class to maintain processing order of value. |
| private static class |
| Modifier and Type | Field and Description |
|---|---|
| protected boolean | _checkDupSquash
Flag used to check, whether the |
| protected JsonDeserializer | _delegateDeserializer
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object. |
| protected final boolean | |
| protected Set | |
| protected Set | |
| protected IgnorePropertiesUtil. | _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
|
| 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
|
| protected final JsonDeserializer | _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 |
| Access | Constructor 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)
|
| Modifier and Type | Method and Description |
|---|---|
| public Map | |
| 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 | |
| protected final Map | _readAndBindStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result)
Optimized method used when keys can be deserialized as plain old
|
| 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
|
| 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. Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for. |
| public Map | 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. Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles. |
| public Map | deserialize(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result)
Overrides com. Alternate deserialization method (compared to the most commonly
used, |
| public Object | deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer
Deserializer to use for handling type information typeDeserializer)Overrides com. Base implementation that does not assume specific type inclusion mechanism. |
| public JsonDeserializer | getContentDeserializer()
Implements abstract com. Accesor for deserializer use for deserializing content values. |
| public final Class | |
| public ValueInstantiator | |
| public JavaType | getValueType()
Overrides com. Exact structured type this deserializer handles, if known. |
| private void | handleUnresolvedReference(DeserializationContext ctxt, MapDeserializer.
|
| public boolean | isCachable()
Overrides com. Turns out that these are expensive enough to create so that caching does make sense. |
| public LogicalType | logicalType()
Overrides com. 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. 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 | |
| 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)
|
| _checkDupSquash | back to summary |
|---|---|
| protected boolean _checkDupSquash Flag used to check, whether the
| |
| _delegateDeserializer | back to summary |
|---|---|
| protected JsonDeserializer<Object> _delegateDeserializer Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object. | |
| _hasDefaultCreator | back to summary |
|---|---|
| protected final boolean _hasDefaultCreator | |
| _ignorableProperties | back to summary |
|---|---|
| protected Set<String> _ignorableProperties | |
| _includableProperties | back to summary |
|---|---|
protected Set<String> _includableProperties
| |
| _inclusionChecker | back to summary |
|---|---|
| protected IgnorePropertiesUtil. Helper object used for name-based filtering
| |
| _keyDeserializer | back to summary |
|---|---|
| protected final KeyDeserializer _keyDeserializer Key deserializer to use; either passed via constructor
(when indicated by annotations), or resolved when
| |
| _propertyBasedCreator | back 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. | |
| _standardStringKey | back to summary |
|---|---|
| protected boolean _standardStringKey Flag set to indicate that the key type is
| |
| _valueDeserializer | back to summary |
|---|---|
| protected final JsonDeserializer<Object> _valueDeserializer Value deserializer. | |
| _valueInstantiator | back to summary |
|---|---|
| protected final ValueInstantiator _valueInstantiator | |
| _valueTypeDeserializer | back to summary |
|---|---|
| protected final TypeDeserializer _valueTypeDeserializer If value instances have polymorphic type information, this is the type deserializer that can handle it | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID Hides com. | |
| MapDeserializer | back to summary |
|---|---|
| public MapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser) | |
| MapDeserializer | back 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. | |
| MapDeserializer | back to summary |
|---|---|
| protected MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable) | |
| MapDeserializer | back to summary |
|---|---|
protected MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)
| |
| _deserializeUsingCreator | back to summary |
|---|---|
public Map
| |
| _isStdKeyDeser | back 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. | |
| _readAndBind | back to summary |
|---|---|
| protected final Map | |
| _readAndBindStringKeyMap | back to summary |
|---|---|
| protected final Map Optimized method used when keys can be deserialized as plain old
| |
| _readAndUpdate | back to summary |
|---|---|
protected final void _readAndUpdate(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException
| |
| _readAndUpdateStringKeyMap | back 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
| |
| _squashDups | back to summary |
|---|---|
protected void _squashDups(final DeserializationContext ctxt, final Map<Object, Object> result, final Object key, final Object oldValue, final Object newValue)
| |
| createContextual | back to summary |
|---|---|
| public JsonDeserializer Implements com. Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.
| |
| deserialize | back to summary |
|---|---|
| public Map Implements abstract com. Doc from com. 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)
| |
| deserialize | back to summary |
|---|---|
| public Map Overrides com. Doc from com. Alternate deserialization method (compared to the most commonly
used,
Default implementation just throws
| |
| deserializeWithType | back to summary |
|---|---|
| public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException Overrides com. Doc from com. 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.
| |
| getContentDeserializer | back to summary |
|---|---|
| public JsonDeserializer Implements abstract com. Doc from com. Accesor for deserializer use for deserializing content values.
| |
| getMapClass | back to summary |
|---|---|
public final Class
| |
| getValueInstantiator | back to summary |
|---|---|
| public ValueInstantiator getValueInstantiator() Overrides com. Implements com.
| |
| getValueType | back to summary |
|---|---|
| public JavaType getValueType() Overrides com. Doc from com. Exact structured type this deserializer handles, if known.
| |
| handleUnresolvedReference | back to summary |
|---|---|
| private void handleUnresolvedReference(DeserializationContext ctxt, MapDeserializer. | |
| isCachable | back to summary |
|---|---|
| public boolean isCachable() Overrides com. 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.
| |
| logicalType | back to summary |
|---|---|
| public LogicalType logicalType() Overrides com. Doc from com. 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.
| |
| resolve | back to summary |
|---|---|
| public void resolve(DeserializationContext ctxt) throws JsonMappingException Implements com. Doc from com. 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).
| |
| setIgnorableProperties | back to summary |
|---|---|
| public void setIgnorableProperties(String[] ignorable)
Deprecated in 2.12, remove from 3.0
| |
| setIgnorableProperties | back to summary |
|---|---|
| public void setIgnorableProperties(Set<String> ignorable) | |
| setIncludableProperties | back to summary |
|---|---|
| public void setIncludableProperties(Set<String> includable) | |
| withResolved | back 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. | |
| withResolved | back to summary |
|---|---|
protected MapDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)
| |
key comes before the values in
next.
| Modifier and Type | Field and Description |
|---|---|
| private final MapDeserializer. | |
| public final Object | |
| public final Map |
| Access | Constructor and Description |
|---|---|
| pack-priv | MapReferring(MapDeserializer.
|
| Modifier and Type | Method and Description |
|---|---|
| public void |
| _parent | back to summary |
|---|---|
| private final MapDeserializer. | |
| key | back to summary |
|---|---|
| public final Object key | |
| next | back to summary |
|---|---|
| public final Map<Object, Object> next | |
| MapReferring | back to summary |
|---|---|
| pack-priv MapReferring(MapDeserializer. | |
| handleResolvedForwardReference | back to summary |
|---|---|
| public void handleResolvedForwardReference(Object id, Object value) throws IOException Implements abstract com.
| |
| Modifier and Type | Field and Description |
|---|---|
| private List | _accumulator
A list of |
| private Map | |
| private final Class |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public ReadableObjectId. | |
| public void | |
| public void |
| _accumulator | back to summary |
|---|---|
| private List<MapDeserializer. A list of | |
| _result | back to summary |
|---|---|
| private Map<Object, Object> _result | |
| _valueType | back to summary |
|---|---|
| private final Class<?> _valueType | |
| MapReferringAccumulator | back to summary |
|---|---|
| public MapReferringAccumulator(Class<?> valueType, Map<Object, Object> result) | |
| handleUnresolvedReference | back to summary |
|---|---|
| public ReadableObjectId. | |
| put | back to summary |
|---|---|
| public void put(Object key, Object value) | |
| resolveForwardReference | back to summary |
|---|---|
| public void resolveForwardReference(Object id, Object value) throws IOException | |