public class MapDeserializer extends ContainerDeserializerBase<Map<Object,Object>> implements ContextualDeserializer, ResolvableDeserializer
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 Map
s, but not with specific
POJO types, only other containers and primitives/wrappers.
JsonDeserializer.None
Modifier and Type | Field and Description |
---|---|
protected JsonDeserializer<Object> |
_delegateDeserializer
Deserializer that is used iff delegate-based creator is
to be used for deserializing from JSON Object.
|
protected boolean |
_hasDefaultCreator |
protected Set<String> |
_ignorableProperties |
protected Set<String> |
_includableProperties |
protected IgnorePropertiesUtil.Checker |
_inclusionChecker
Helper object used for name-based filtering
|
protected KeyDeserializer |
_keyDeserializer
Key deserializer to use; either passed via constructor
(when indicated by annotations), or resolved when
resolve(com.fasterxml.jackson.databind.DeserializationContext) 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
|
protected JsonDeserializer<Object> |
_valueDeserializer
Value deserializer.
|
protected ValueInstantiator |
_valueInstantiator |
protected TypeDeserializer |
_valueTypeDeserializer
If value instances have polymorphic type information, this
is the type deserializer that can handle it
|
_containerType, _nullProvider, _skipNullValues, _unwrapSingle
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
Modifier | Constructor and Description |
---|---|
|
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 |
---|---|
Map<Object,Object> |
_deserializeUsingCreator(JsonParser p,
DeserializationContext ctxt) |
protected 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 void |
_readAndBind(JsonParser p,
DeserializationContext ctxt,
Map<Object,Object> result) |
protected void |
_readAndBindStringKeyMap(JsonParser p,
DeserializationContext ctxt,
Map<Object,Object> result)
Optimized method used when keys can be deserialized as plain old
String s, and there is no custom deserialized
specified. |
protected void |
_readAndUpdate(JsonParser p,
DeserializationContext ctxt,
Map<Object,Object> result) |
protected void |
_readAndUpdateStringKeyMap(JsonParser p,
DeserializationContext ctxt,
Map<Object,Object> result)
Optimized method used when keys can be deserialized as plain old
String s, and there is no custom deserializer
specified. |
JsonDeserializer<?> |
createContextual(DeserializationContext ctxt,
BeanProperty property)
Method called to finalize setup of this deserializer,
when it is known for which property deserializer is needed for.
|
Map<Object,Object> |
deserialize(JsonParser p,
DeserializationContext ctxt)
Method that can be called to ask implementation to deserialize
JSON content into the value type this serializer handles.
|
Map<Object,Object> |
deserialize(JsonParser p,
DeserializationContext ctxt,
Map<Object,Object> result)
Alternate deserialization method (compared to the most commonly
used,
JsonDeserializer.deserialize(JsonParser, DeserializationContext) ),
which takes in initialized value instance, to be
configured and/or populated by deserializer. |
Object |
deserializeWithType(JsonParser p,
DeserializationContext ctxt,
TypeDeserializer typeDeserializer)
Base implementation that does not assume specific type
inclusion mechanism.
|
JsonDeserializer<Object> |
getContentDeserializer()
Accesor for deserializer use for deserializing content values.
|
Class<?> |
getMapClass() |
ValueInstantiator |
getValueInstantiator() |
JavaType |
getValueType()
Exact structured type this deserializer handles, if known.
|
boolean |
isCachable()
Turns out that these are expensive enough to create so that caching
does make sense.
|
LogicalType |
logicalType()
Method for accessing logical type of values this deserializer produces.
|
void |
resolve(DeserializationContext ctxt)
Method called after deserializer instance has been constructed
(and registered as necessary by provider objects),
but before it has returned it to the caller.
|
void |
setIgnorableProperties(Set<String> ignorable) |
void |
setIgnorableProperties(String[] ignorable)
Deprecated.
in 2.12, remove from 3.0
|
void |
setIncludableProperties(Set<String> includable) |
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) |
findBackReference, getContentType, getEmptyAccessPattern, getEmptyValue, supportsUpdate, wrapAndThrow, wrapAndThrow
_byteOverflow, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkTextualNull, _coerceBooleanFromInt, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _failDoubleToIntCoercion, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isEmptyOrTextualNull, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueType, handledType, handleMissingEndArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer
deserializeWithType, getAbsentValue, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getNullValue, getNullValue, getObjectIdReader, replaceDelegatee, unwrappingDeserializer
protected final KeyDeserializer _keyDeserializer
resolve(com.fasterxml.jackson.databind.DeserializationContext)
is called;protected boolean _standardStringKey
protected final JsonDeserializer<Object> _valueDeserializer
protected final TypeDeserializer _valueTypeDeserializer
protected final ValueInstantiator _valueInstantiator
protected JsonDeserializer<Object> _delegateDeserializer
protected PropertyBasedCreator _propertyBasedCreator
protected final boolean _hasDefaultCreator
protected IgnorePropertiesUtil.Checker _inclusionChecker
public MapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)
protected MapDeserializer(MapDeserializer src)
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)
protected MapDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable)
protected MapDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable)
protected final boolean _isStdKeyDeser(JavaType mapType, KeyDeserializer keyDeser)
@Deprecated public void setIgnorableProperties(String[] ignorable)
public void resolve(DeserializationContext ctxt) throws JsonMappingException
ResolvableDeserializer
resolve
in interface ResolvableDeserializer
ctxt
- Context to use for accessing configuration, resolving
secondary deserializersJsonMappingException
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException
createContextual
in interface ContextualDeserializer
ctxt
- Deserialization context to access configuration, additional
deserializers that may be needed by this deserializerproperty
- 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)JsonMappingException
public JsonDeserializer<Object> getContentDeserializer()
ContainerDeserializerBase
getContentDeserializer
in class ContainerDeserializerBase<Map<Object,Object>>
public ValueInstantiator getValueInstantiator()
getValueInstantiator
in interface ValueInstantiator.Gettable
getValueInstantiator
in class StdDeserializer<Map<Object,Object>>
public boolean isCachable()
IMPORTANT: 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.
isCachable
in class JsonDeserializer<Map<Object,Object>>
public LogicalType logicalType()
JsonDeserializer
logicalType
in class JsonDeserializer<Map<Object,Object>>
null
if notpublic Map<Object,Object> deserialize(JsonParser p, DeserializationContext ctxt) throws IOException
JsonDeserializer
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).
Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.
deserialize
in class JsonDeserializer<Map<Object,Object>>
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about
this deserialization activity.IOException
public Map<Object,Object> deserialize(JsonParser p, DeserializationContext ctxt, Map<Object,Object> result) throws IOException
JsonDeserializer
JsonDeserializer.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)
deserialize
in class JsonDeserializer<Map<Object,Object>>
IOException
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException
StdDeserializer
deserializeWithType
in class StdDeserializer<Map<Object,Object>>
typeDeserializer
- Deserializer to use for handling type informationIOException
public final Class<?> getMapClass()
public JavaType getValueType()
StdDeserializer
getValueType
in class ContainerDeserializerBase<Map<Object,Object>>
protected final void _readAndBind(JsonParser p, DeserializationContext ctxt, Map<Object,Object> result) throws IOException
IOException
protected final void _readAndBindStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object,Object> result) throws IOException
String
s, and there is no custom deserialized
specified.IOException
public Map<Object,Object> _deserializeUsingCreator(JsonParser p, DeserializationContext ctxt) throws IOException
IOException
protected final void _readAndUpdate(JsonParser p, DeserializationContext ctxt, Map<Object,Object> result) throws IOException
IOException
protected final void _readAndUpdateStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object,Object> result) throws IOException
String
s, and there is no custom deserializer
specified.IOException
Copyright © 2008–2021 FasterXML. All rights reserved.