org.codehaus.jackson.map.deser
Class MapDeserializer

java.lang.Object
  extended by org.codehaus.jackson.map.JsonDeserializer<T>
      extended by org.codehaus.jackson.map.deser.StdDeserializer<Map<Object,Object>>
          extended by org.codehaus.jackson.map.deser.MapDeserializer
All Implemented Interfaces:
ResolvableDeserializer

public class MapDeserializer
extends StdDeserializer<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.StdDeserializer
StdDeserializer.BigDecimalDeserializer, StdDeserializer.BigIntegerDeserializer, StdDeserializer.BooleanDeserializer, StdDeserializer.ByteDeserializer, StdDeserializer.CalendarDeserializer, StdDeserializer.CharacterDeserializer, StdDeserializer.ClassDeserializer, StdDeserializer.DoubleDeserializer, StdDeserializer.FloatDeserializer, StdDeserializer.IntegerDeserializer, StdDeserializer.LongDeserializer, StdDeserializer.NumberDeserializer, StdDeserializer.PrimitiveOrWrapperDeserializer<T>, StdDeserializer.ShortDeserializer, StdDeserializer.SqlDateDeserializer, StdDeserializer.StackTraceElementDeserializer, StdDeserializer.StringDeserializer
 
Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonDeserializer
JsonDeserializer.None
 
Field Summary
protected  org.codehaus.jackson.map.deser.Creator.PropertyBased _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.
 
Constructor Summary
MapDeserializer(JavaType mapType, Constructor<Map<Object,Object>> defCtor, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser)
           
 
Method Summary
 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, which is to be configured and/or populated by deserializer.
 Class<?> getMapClass()
           
 JavaType getValueType()
           
 void resolve(DeserializationConfig config, DeserializerProvider provider)
          Method called to finalize setup of this deserializer, after deserializer itself has been registered.
 void setCreators(CreatorContainer creators)
          Method called to add constructor and/or factory method based creators to be used with Map, instead of default constructor.
 void validateCreators()
           
 
Methods inherited from class org.codehaus.jackson.map.deser.StdDeserializer
_parseBoolean, _parseDate, _parseDouble, _parseFloat, _parseInt, _parseLong, _parseShort, findDeserializer, getValueClass, handleUnknownProperty, reportUnknownProperty
 
Methods inherited from class org.codehaus.jackson.map.JsonDeserializer
getNullValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_propertyBasedCreator

protected org.codehaus.jackson.map.deser.Creator.PropertyBased _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.

Constructor Detail

MapDeserializer

public MapDeserializer(JavaType mapType,
                       Constructor<Map<Object,Object>> defCtor,
                       KeyDeserializer keyDeser,
                       JsonDeserializer<Object> valueDeser)
Method Detail

setCreators

public void setCreators(CreatorContainer creators)
Method called to add constructor and/or factory method based creators to be used with Map, instead of default constructor.


validateCreators

public void validateCreators()
                      throws JsonMappingException
Throws:
JsonMappingException

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

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, which is to be configured and/or populated by deserializer. Method is only used for subset of all supported types; most commonly just for Collections and Maps, but potentially also for beans/POJOs.

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

getMapClass

public final Class<?> getMapClass()

getValueType

public JavaType getValueType()
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