Class MapDeserializer
- java.lang.Object
-
- org.codehaus.jackson.map.JsonDeserializer<T>
-
- org.codehaus.jackson.map.deser.std.StdDeserializer<T>
-
- org.codehaus.jackson.map.deser.std.ContainerDeserializerBase<java.util.Map<java.lang.Object,java.lang.Object>>
-
- org.codehaus.jackson.map.deser.std.MapDeserializer
-
- All Implemented Interfaces:
ResolvableDeserializer
- Direct Known Subclasses:
MapDeserializer
public class MapDeserializer extends ContainerDeserializerBase<java.util.Map<java.lang.Object,java.lang.Object>> implements ResolvableDeserializer
Basic serializer that can take Json "Object" structure and construct aMap
instance, with typed contents.Note: for untyped content (one indicated by passing Object.class as the type),
UntypedObjectDeserializer
is used instead. It can also constructMap
s, but not with specific POJO types, only other containers and primitives/wrappers.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.codehaus.jackson.map.deser.std.StdDeserializer
StdDeserializer.BigDecimalDeserializer, StdDeserializer.BigIntegerDeserializer, StdDeserializer.BooleanDeserializer, StdDeserializer.ByteDeserializer, StdDeserializer.CharacterDeserializer, StdDeserializer.DoubleDeserializer, StdDeserializer.FloatDeserializer, StdDeserializer.IntegerDeserializer, StdDeserializer.LongDeserializer, StdDeserializer.NumberDeserializer, StdDeserializer.PrimitiveOrWrapperDeserializer<T>, StdDeserializer.ShortDeserializer, StdDeserializer.SqlDateDeserializer, StdDeserializer.StackTraceElementDeserializer
-
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonDeserializer
JsonDeserializer.None
-
-
Field Summary
Fields Modifier and Type Field Description protected JsonDeserializer<java.lang.Object>
_delegateDeserializer
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.protected boolean
_hasDefaultCreator
protected java.util.HashSet<java.lang.String>
_ignorableProperties
protected KeyDeserializer
_keyDeserializer
Key deserializer used, if not null.protected JavaType
_mapType
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 JsonDeserializer<java.lang.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-
Fields inherited from class org.codehaus.jackson.map.deser.std.StdDeserializer
_valueClass
-
-
Constructor Summary
Constructors Modifier Constructor Description 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(JavaType mapType, java.lang.reflect.Constructor<java.util.Map<java.lang.Object,java.lang.Object>> defCtor, KeyDeserializer keyDeser, JsonDeserializer<java.lang.Object> valueDeser, TypeDeserializer valueTypeDeser)
Deprecated.Since 1.9, use variant that takes ValueInstantiatorMapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<java.lang.Object> valueDeser, TypeDeserializer valueTypeDeser)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.Object,java.lang.Object>
_deserializeUsingCreator(JsonParser jp, DeserializationContext ctxt)
protected void
_readAndBind(JsonParser jp, DeserializationContext ctxt, java.util.Map<java.lang.Object,java.lang.Object> result)
java.util.Map<java.lang.Object,java.lang.Object>
deserialize(JsonParser jp, DeserializationContext ctxt)
Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.java.util.Map<java.lang.Object,java.lang.Object>
deserialize(JsonParser jp, DeserializationContext ctxt, java.util.Map<java.lang.Object,java.lang.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.java.lang.Object
deserializeWithType(JsonParser jp, DeserializationContext ctxt, TypeDeserializer typeDeserializer)
Base implementation that does not assume specific type inclusion mechanism.JsonDeserializer<java.lang.Object>
getContentDeserializer()
Accesor for deserializer use for deserializing content values.JavaType
getContentType()
Accessor for declared type of contained value elements; either exact type, or one of its supertypes.java.lang.Class<?>
getMapClass()
JavaType
getValueType()
Exact structured type deserializer handles, if known.void
resolve(DeserializationConfig config, DeserializerProvider provider)
Method called to finalize setup of this deserializer, after deserializer itself has been registered.void
setIgnorableProperties(java.lang.String[] ignorable)
protected void
wrapAndThrow(java.lang.Throwable t, java.lang.Object ref)
-
Methods inherited from class org.codehaus.jackson.map.deser.std.StdDeserializer
_parseBoolean, _parseBooleanFromNumber, _parseBooleanPrimitive, _parseByte, _parseDate, _parseDouble, _parseDoublePrimitive, _parseFloat, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseShort, _parseShortPrimitive, findDeserializer, getValueClass, handleUnknownProperty, isDefaultSerializer, parseDouble, reportUnknownProperty
-
Methods inherited from class org.codehaus.jackson.map.JsonDeserializer
getEmptyValue, getNullValue, unwrappingDeserializer
-
-
-
-
Field Detail
-
_mapType
protected final JavaType _mapType
-
_keyDeserializer
protected final KeyDeserializer _keyDeserializer
Key deserializer used, if not null. If null, String from JSON content is used as is.
-
_valueDeserializer
protected final JsonDeserializer<java.lang.Object> _valueDeserializer
Value deserializer.
-
_valueTypeDeserializer
protected final TypeDeserializer _valueTypeDeserializer
If value instances have polymorphic type information, this is the type deserializer that can handle it
-
_valueInstantiator
protected final ValueInstantiator _valueInstantiator
- Since:
- 1.9
-
_hasDefaultCreator
protected final boolean _hasDefaultCreator
- Since:
- 1.9
-
_propertyBasedCreator
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.
-
_delegateDeserializer
protected JsonDeserializer<java.lang.Object> _delegateDeserializer
Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.
-
_ignorableProperties
protected java.util.HashSet<java.lang.String> _ignorableProperties
-
-
Constructor Detail
-
MapDeserializer
@Deprecated protected MapDeserializer(JavaType mapType, java.lang.reflect.Constructor<java.util.Map<java.lang.Object,java.lang.Object>> defCtor, KeyDeserializer keyDeser, JsonDeserializer<java.lang.Object> valueDeser, TypeDeserializer valueTypeDeser)
Deprecated.Since 1.9, use variant that takes ValueInstantiator
-
MapDeserializer
public MapDeserializer(JavaType mapType, ValueInstantiator valueInstantiator, KeyDeserializer keyDeser, JsonDeserializer<java.lang.Object> valueDeser, TypeDeserializer valueTypeDeser)
-
MapDeserializer
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.- Since:
- 1.9
-
-
Method Detail
-
setIgnorableProperties
public void setIgnorableProperties(java.lang.String[] ignorable)
-
resolve
public void resolve(DeserializationConfig config, DeserializerProvider provider) throws JsonMappingException
Method called to finalize setup of this deserializer, after deserializer itself has been registered. This is needed to handle recursive and transitive dependencies.- Specified by:
resolve
in interfaceResolvableDeserializer
provider
- Provider that has constructed deserializer this method is called on.- Throws:
JsonMappingException
-
getContentType
public JavaType getContentType()
Description copied from class:ContainerDeserializerBase
Accessor for declared type of contained value elements; either exact type, or one of its supertypes.- Specified by:
getContentType
in classContainerDeserializerBase<java.util.Map<java.lang.Object,java.lang.Object>>
-
getContentDeserializer
public JsonDeserializer<java.lang.Object> getContentDeserializer()
Description copied from class:ContainerDeserializerBase
Accesor for deserializer use for deserializing content values.- Specified by:
getContentDeserializer
in classContainerDeserializerBase<java.util.Map<java.lang.Object,java.lang.Object>>
-
deserialize
public java.util.Map<java.lang.Object,java.lang.Object> deserialize(JsonParser jp, DeserializationContext ctxt) throws java.io.IOException, JsonProcessingException
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. 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<java.util.Map<java.lang.Object,java.lang.Object>>
- Parameters:
jp
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about this deserialization activity.- Returns:
- Deserializer value
- Throws:
java.io.IOException
JsonProcessingException
-
deserialize
public java.util.Map<java.lang.Object,java.lang.Object> deserialize(JsonParser jp, DeserializationContext ctxt, java.util.Map<java.lang.Object,java.lang.Object> result) throws java.io.IOException, JsonProcessingException
Description 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 for all supported types; most commonly it is used for Collections and Maps.Default implementation just throws
UnsupportedOperationException
, to indicate that types that do not explicitly add support do not expect to get the call.- Overrides:
deserialize
in classJsonDeserializer<java.util.Map<java.lang.Object,java.lang.Object>>
- Throws:
java.io.IOException
JsonProcessingException
-
deserializeWithType
public java.lang.Object deserializeWithType(JsonParser jp, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws java.io.IOException, JsonProcessingException
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<java.util.Map<java.lang.Object,java.lang.Object>>
typeDeserializer
- Deserializer to use for handling type information- Throws:
java.io.IOException
JsonProcessingException
-
getMapClass
public final java.lang.Class<?> getMapClass()
-
getValueType
public JavaType getValueType()
Description copied from class:StdDeserializer
Exact structured type deserializer handles, if known.Default implementation just returns null.
- Overrides:
getValueType
in classStdDeserializer<java.util.Map<java.lang.Object,java.lang.Object>>
-
_readAndBind
protected final void _readAndBind(JsonParser jp, DeserializationContext ctxt, java.util.Map<java.lang.Object,java.lang.Object> result) throws java.io.IOException, JsonProcessingException
- Throws:
java.io.IOException
JsonProcessingException
-
_deserializeUsingCreator
public java.util.Map<java.lang.Object,java.lang.Object> _deserializeUsingCreator(JsonParser jp, DeserializationContext ctxt) throws java.io.IOException, JsonProcessingException
- Throws:
java.io.IOException
JsonProcessingException
-
wrapAndThrow
protected void wrapAndThrow(java.lang.Throwable t, java.lang.Object ref) throws java.io.IOException
- Throws:
java.io.IOException
-
-