com.fasterxml.jackson.databind.deser.std

Class MapEntryDeserializer

java.lang.Object

com.fasterxml.jackson.databind.JsonDeserializer<T>

com.fasterxml.jackson.databind.deser.std.StdDeserializer<T>

com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase<Map.Entry<Object,Object>>

com.fasterxml.jackson.databind.deser.std.MapEntryDeserializer

All Implemented Interfaces:

ContextualDeserializer, Serializable

public class MapEntryDeserializer
extends ContainerDeserializerBase<Map.Entry<Object,Object>>
implements ContextualDeserializer

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.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

JsonDeserializer.None

Field Summary

Fields

Modifier and Type	Field and Description
protected KeyDeserializer	_keyDeserializer Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved when createContextual(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.BeanProperty) is called;
protected JavaType	_type
protected JsonDeserializer<Object>	_valueDeserializer Value deserializer.
protected TypeDeserializer	_valueTypeDeserializer If value instances have polymorphic type information, this is the type deserializer that can handle it

Fields inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

_valueClass

Constructor Summary

Constructors

Modifier	Constructor and Description
	MapEntryDeserializer(JavaType type, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)
protected	MapEntryDeserializer(MapEntryDeserializer src) Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.
protected	MapEntryDeserializer(MapEntryDeserializer src, KeyDeserializer keyDeser, JsonDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)

Method Summary

Methods

Modifier and Type	Method and Description
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.Entry<Object,Object>	deserialize(com.fasterxml.jackson.core.JsonParser jp, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
Map.Entry<Object,Object>	deserialize(com.fasterxml.jackson.core.JsonParser jp, DeserializationContext ctxt, Map.Entry<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(com.fasterxml.jackson.core.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.
JavaType	getValueType() Exact structured type deserializer handles, if known.
protected MapEntryDeserializer	withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, JsonDeserializer<?> valueDeser) Fluent factory method used to create a copy with slightly different settings.

Methods inherited from class com.fasterxml.jackson.databind.deser.std.ContainerDeserializerBase

findBackReference, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

_deserializeFromEmpty, _hasTextualNull, _isNaN, _isNegInf, _isPosInf, _parseBoolean, _parseBooleanFromNumber, _parseBooleanPrimitive, _parseByte, _parseDate, _parseDouble, _parseDoublePrimitive, _parseFloat, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseShort, _parseShortPrimitive, _parseString, findConvertingContentDeserializer, findDeserializer, getValueClass, handledType, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

getDelegatee, getEmptyValue, getKnownPropertyNames, getNullValue, getObjectIdReader, isCachable, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object

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

Field Detail

_type

protected final JavaType _type

_keyDeserializer

protected final KeyDeserializer _keyDeserializer

Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved when createContextual(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.BeanProperty) is called;

_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

Constructor Detail

MapEntryDeserializer

public MapEntryDeserializer(JavaType type,
                    KeyDeserializer keyDeser,
                    JsonDeserializer<Object> valueDeser,
                    TypeDeserializer valueTypeDeser)

MapEntryDeserializer

protected MapEntryDeserializer(MapEntryDeserializer src)

Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.

MapEntryDeserializer

protected MapEntryDeserializer(MapEntryDeserializer src,
                    KeyDeserializer keyDeser,
                    JsonDeserializer<Object> valueDeser,
                    TypeDeserializer valueTypeDeser)

Method Detail

withResolved

protected MapEntryDeserializer withResolved(KeyDeserializer keyDeser,
                                TypeDeserializer valueTypeDeser,
                                JsonDeserializer<?> valueDeser)

Fluent factory method used to create a copy with slightly different settings. When sub-classing, MUST be overridden.

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 interface ContextualDeserializer

Parameters:

ctxt - Deserialization context to access configuration, additional deserializers that may be needed by this deserializer

property - 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 can not 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

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.Entry<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.Entry<Object,Object>>

deserialize

public Map.Entry<Object,Object> deserialize(com.fasterxml.jackson.core.JsonParser jp,
                                   DeserializationContext ctxt)
                                     throws IOException

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 (jp.getCurrentToken() == JsonToken.START_OBJECT) {
         jp.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 class JsonDeserializer<Map.Entry<Object,Object>>

Parameters:

jp - Parsed used for reading JSON content

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

Returns:

Deserialized value

Throws:

IOException

deserialize

public Map.Entry<Object,Object> deserialize(com.fasterxml.jackson.core.JsonParser jp,
                                   DeserializationContext ctxt,
                                   Map.Entry<Object,Object> result)
                                     throws IOException

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 (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 class JsonDeserializer<Map.Entry<Object,Object>>

Throws:

IOException

deserializeWithType

public Object deserializeWithType(com.fasterxml.jackson.core.JsonParser jp,
                         DeserializationContext ctxt,
                         TypeDeserializer typeDeserializer)
                           throws IOException,
                                  com.fasterxml.jackson.core.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.Entry<Object,Object>>

typeDeserializer - Deserializer to use for handling type information

Throws:

IOException

com.fasterxml.jackson.core.JsonProcessingException

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.Entry<Object,Object>>