org.codehaus.jackson.map.deser.std

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<Map<Object,Object>>

org.codehaus.jackson.map.deser.std.MapDeserializer

All Implemented Interfaces:

ResolvableDeserializer

Direct Known Subclasses:

MapDeserializer

public class MapDeserializer
extends ContainerDeserializerBase<Map<Object,Object>>
implements ResolvableDeserializer

Basic serializer that can take Json "Object" structure and construct a 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 Maps, 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 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 HashSet<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<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 and Description
protected	MapDeserializer(JavaType mapType, Constructor<Map<Object,Object>> defCtor, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser) Deprecated. Since 1.9, use variant that takes ValueInstantiator
	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.

Method Summary

Methods

Modifier and Type	Method and Description
Map<Object,Object>	_deserializeUsingCreator(JsonParser jp, DeserializationContext ctxt)
protected void	_readAndBind(JsonParser jp, DeserializationContext ctxt, Map<Object,Object> result)
Map<Object,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.
Map<Object,Object>	deserialize(JsonParser jp, 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 jp, 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.
JavaType	getContentType() Accessor for declared type of contained value elements; either exact type, or one of its supertypes.
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(String[] ignorable)
protected void	wrapAndThrow(Throwable t, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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<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<Object> _delegateDeserializer

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

_ignorableProperties

protected HashSet<String> _ignorableProperties

Constructor Detail

MapDeserializer

@Deprecated
protected MapDeserializer(JavaType mapType,
                          Constructor<Map<Object,Object>> defCtor,
                          KeyDeserializer keyDeser,
                          JsonDeserializer<Object> valueDeser,
                          TypeDeserializer valueTypeDeser)

Deprecated. Since 1.9, use variant that takes ValueInstantiator

MapDeserializer

public MapDeserializer(JavaType mapType,
               ValueInstantiator valueInstantiator,
               KeyDeserializer keyDeser,
               JsonDeserializer<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(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 interface ResolvableDeserializer

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 class ContainerDeserializerBase<Map<Object,Object>>

getContentDeserializer

public JsonDeserializer<Object> getContentDeserializer()

Description copied from class: ContainerDeserializerBase

Accesor for deserializer use for deserializing content values.

Specified by:

getContentDeserializer in class ContainerDeserializerBase<Map<Object,Object>>

deserialize

public Map<Object,Object> deserialize(JsonParser jp,
                             DeserializationContext ctxt)
                               throws 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 class JsonDeserializer<Map<Object,Object>>

Parameters:

jp - Parsed used for reading JSON content

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

Returns:

Deserializer value

Throws:

IOException

JsonProcessingException

deserialize

public Map<Object,Object> deserialize(JsonParser jp,
                             DeserializationContext ctxt,
                             Map<Object,Object> result)
                               throws 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 class JsonDeserializer<Map<Object,Object>>

Throws:

IOException

JsonProcessingException

deserializeWithType

public Object deserializeWithType(JsonParser jp,
                         DeserializationContext ctxt,
                         TypeDeserializer typeDeserializer)
                           throws 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 class StdDeserializer<Map<Object,Object>>

typeDeserializer - Deserializer to use for handling type information

Throws:

IOException

JsonProcessingException

getMapClass

public final 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 class StdDeserializer<Map<Object,Object>>

_readAndBind

protected final void _readAndBind(JsonParser jp,
                DeserializationContext ctxt,
                Map<Object,Object> result)
                           throws IOException,
                                  JsonProcessingException

Throws:

IOException

JsonProcessingException

_deserializeUsingCreator

public Map<Object,Object> _deserializeUsingCreator(JsonParser jp,
                                          DeserializationContext ctxt)
                                            throws IOException,
                                                   JsonProcessingException

Throws:

IOException

JsonProcessingException

wrapAndThrow

protected void wrapAndThrow(Throwable t,
                Object ref)
                     throws IOException

Throws:

IOException