Class MapDeserializer
- All Implemented Interfaces:
ContextualDeserializer
,NullValueProvider
,ResolvableDeserializer
,ValueInstantiator.Gettable
,Serializable
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.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer
JsonDeserializer.None
-
Field Summary
Modifier and TypeFieldDescriptionprotected boolean
Flag used to check, whether theStreamReadCapability.DUPLICATE_PROPERTIES
can be applied, because the Map has declared value type ofjava.lang.Object
.protected JsonDeserializer<Object>
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.protected final boolean
protected IgnorePropertiesUtil.Checker
Helper object used for name-based filteringprotected final KeyDeserializer
Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved whenresolve(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext)
is called;protected 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
protected final JsonDeserializer<Object>
Value deserializer.protected final ValueInstantiator
protected final TypeDeserializer
If value instances have polymorphic type information, this is the type deserializer that can handle itFields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase
_containerType, _nullProvider, _skipNullValues, _unwrapSingle
Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.std.StdDeserializer
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
-
Constructor Summary
ModifierConstructorDescriptionprotected
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) MapDeserializer
(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser) -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) _readAndBindStringKeyMap
(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) Optimized method used when keys can be deserialized as plain oldString
s, and there is no custom deserialized specified.protected final void
_readAndUpdate
(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) protected final void
_readAndUpdateStringKeyMap
(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) Optimized method used when keys can be deserialized as plain oldString
s, and there is no custom deserializer specified.protected void
_squashDups
(DeserializationContext ctxt, Map<Object, Object> result, Object key, Object oldValue, Object newValue) createContextual
(DeserializationContext ctxt, BeanProperty property) Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.deserialize
(JsonParser p, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.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.deserializeWithType
(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) Base implementation that does not assume specific type inclusion mechanism.Accesor for deserializer use for deserializing content values.final Class<?>
Exact structured type this deserializer handles, if known.boolean
Turns out that these are expensive enough to create so that caching does make sense.Method for accessing logical type of values this deserializer produces.void
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
(String[] ignorable) Deprecated.in 2.12, remove from 3.0void
setIgnorableProperties
(Set<String> ignorable) 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) Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase
findBackReference, getContentType, getEmptyAccessPattern, getEmptyValue, supportsUpdate, wrapAndThrow, wrapAndThrow
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.deser.std.StdDeserializer
_byteOverflow, _checkBooleanToStringCoercion, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFloatToStringCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkIntToFloatCoercion, _checkIntToStringCoercion, _checkTextualNull, _checkToStringCoercion, _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, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueType, handledType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer
Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.JsonDeserializer
deserializeWithType, getAbsentValue, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getNullValue, getNullValue, getObjectIdReader, replaceDelegatee, unwrappingDeserializer
-
Field Details
-
_keyDeserializer
Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved whenresolve(edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.DeserializationContext)
is called; -
_standardStringKey
protected boolean _standardStringKey -
_valueDeserializer
Value deserializer. -
_valueTypeDeserializer
If value instances have polymorphic type information, this is the type deserializer that can handle it -
_valueInstantiator
-
_delegateDeserializer
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object. -
_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. -
_hasDefaultCreator
protected final boolean _hasDefaultCreator -
_ignorableProperties
-
_includableProperties
- Since:
- 2.12
-
_inclusionChecker
Helper object used for name-based filtering- Since:
- 2.12
-
_checkDupSquash
protected boolean _checkDupSquashFlag used to check, whether theStreamReadCapability.DUPLICATE_PROPERTIES
can be applied, because the Map has declared value type ofjava.lang.Object
.- Since:
- 2.14
-
-
Constructor Details
-
MapDeserializer
public MapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser) -
MapDeserializer
Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance. -
MapDeserializer
protected MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable) -
MapDeserializer
protected MapDeserializer(MapDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable) - Since:
- 2.12
-
-
Method Details
-
withResolved
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
protected MapDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser, NullValueProvider nuller, Set<String> ignorable, Set<String> includable) - Since:
- 2.12
-
_isStdKeyDeser
Helper method used to check whether we can just use the default key deserialization, where JSON String becomes Java String. -
setIgnorableProperties
Deprecated.in 2.12, remove from 3.0 -
setIgnorableProperties
-
setIncludableProperties
-
resolve
Description copied from interface:ResolvableDeserializer
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).- Specified by:
resolve
in interfaceResolvableDeserializer
- Parameters:
ctxt
- Context to use for accessing configuration, resolving secondary deserializers- Throws:
JsonMappingException
-
createContextual
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.- Specified by:
createContextual
in interfaceContextualDeserializer
- Parameters:
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)- Returns:
- Deserializer to use for deserializing values of specified property; may be this instance or a new instance.
- Throws:
JsonMappingException
-
getContentDeserializer
Description copied from class:ContainerDeserializerBase
Accesor for deserializer use for deserializing content values.- Specified by:
getContentDeserializer
in classContainerDeserializerBase<Map<Object,
Object>>
-
getValueInstantiator
- Specified by:
getValueInstantiator
in interfaceValueInstantiator.Gettable
- Overrides:
getValueInstantiator
in classStdDeserializer<Map<Object,
Object>>
-
isCachable
public boolean isCachable()Turns out that these are expensive enough to create so that caching does make sense.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.
- Overrides:
isCachable
in classJsonDeserializer<Map<Object,
Object>> - Since:
- 2.4.4
-
logicalType
Description copied from class:JsonDeserializer
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.- Overrides:
logicalType
in classJsonDeserializer<Map<Object,
Object>> - Returns:
- Logical type of values this deserializer produces, if known;
null
if not
-
deserialize
Description copied from class:JsonDeserializer
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).
Note that this method is never called for JSON null literal, and thus deserializers need (and should) not check for it.
- Specified by:
deserialize
in classJsonDeserializer<Map<Object,
Object>> - Parameters:
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about this deserialization activity.- Returns:
- Deserialized value
- Throws:
IOException
-
deserialize
public Map<Object,Object> deserialize(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOExceptionDescription copied from class:JsonDeserializer
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. 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)- Overrides:
deserialize
in classJsonDeserializer<Map<Object,
Object>> - Throws:
IOException
-
deserializeWithType
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException Description copied from class:StdDeserializer
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.- Overrides:
deserializeWithType
in classStdDeserializer<Map<Object,
Object>> typeDeserializer
- Deserializer to use for handling type information- Throws:
IOException
-
getMapClass
-
getValueType
Description copied from class:StdDeserializer
Exact structured type this deserializer handles, if known.- Overrides:
getValueType
in classContainerDeserializerBase<Map<Object,
Object>>
-
_readAndBind
protected final Map<Object,Object> _readAndBind(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException- Throws:
IOException
-
_readAndBindStringKeyMap
protected final Map<Object,Object> _readAndBindStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOExceptionOptimized method used when keys can be deserialized as plain oldString
s, and there is no custom deserialized specified.- Throws:
IOException
-
_deserializeUsingCreator
public Map<Object,Object> _deserializeUsingCreator(JsonParser p, DeserializationContext ctxt) throws IOException - Throws:
IOException
-
_readAndUpdate
protected final void _readAndUpdate(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOException- Throws:
IOException
- Since:
- 2.9
-
_readAndUpdateStringKeyMap
protected final void _readAndUpdateStringKeyMap(JsonParser p, DeserializationContext ctxt, Map<Object, Object> result) throws IOExceptionOptimized method used when keys can be deserialized as plain oldString
s, and there is no custom deserializer specified.- Throws:
IOException
- Since:
- 2.9
-
_squashDups
protected void _squashDups(DeserializationContext ctxt, Map<Object, Object> result, Object key, Object oldValue, Object newValue) - Since:
- 2.14
-