Top Description Fields Constructors Methods
tools.jackson.databind.deser.jdk

public Class MapEntryDeserializer

extends ContainerDeserializerBase<Map.Entry<Object, Object>>
Class Inheritance
Annotations
@JacksonStdImpl
Imports
java.util.*, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.annotation.JacksonStdImpl, tools.jackson.databind.deser.*, tools.jackson.databind.deser.std.ContainerDeserializerBase, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType

Basic serializer that can take JSON "Object" structure and construct a java.util.Map.Entry 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 java.util.Map.Entrys, but not with specific POJO types, only other containers and primitives/wrappers.

Field Summary

Modifier and TypeField and Description
protected final KeyDeserializer
_keyDeserializer

Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved when createContextual is called;

protected final ValueDeserializer<Object>
_valueDeserializer

Value deserializer.

protected final TypeDeserializer
_valueTypeDeserializer

If value instances have polymorphic type information, this is the type deserializer that can handle it

Inherited from tools.jackson.databind.deser.std.ContainerDeserializerBase:
_containerType_nullProvider_skipNullValues_unwrapSingle

Constructor Summary

AccessConstructor and Description
public
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

Method Summary

Modifier and TypeMethod and Description
public ValueDeserializer<?>
createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.

public Map.Entry<Object, Object>
deserialize(JsonParser p, DeserializationContext ctxt)

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.

public Map.Entry<Object, Object>
deserialize(JsonParser p, DeserializationContext ctxt, Map.Entry<Object, Object> result)

Overrides tools.jackson.databind.ValueDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, deserialize(JsonParser, DeserializationContext)), which takes in initialized value instance, to be configured and/or populated by deserializer.

public Object
deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Base implementation that does not assume specific type inclusion mechanism.

public ValueDeserializer<Object>
getContentDeserializer()

Implements abstract tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

public JavaType
getContentType()

Overrides tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentType.

Accessor for declared type of contained value elements; either exact type, or one of its supertypes.

public LogicalType
logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

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

Fluent factory method used to create a copy with slightly different settings.

Inherited from tools.jackson.databind.deser.std.ContainerDeserializerBase:
findBackReferencegetEmptyAccessPatterngetEmptyValuegetValueTypesupportsUpdatewrapAndThrow

Field Detail

_keyDeserializerback to summary
protected final KeyDeserializer _keyDeserializer

Key deserializer to use; either passed via constructor (when indicated by annotations), or resolved when createContextual is called;

_valueDeserializerback to summary
protected final ValueDeserializer<Object> _valueDeserializer

Value deserializer.

_valueTypeDeserializerback to summary
protected final TypeDeserializer _valueTypeDeserializer

If value instances have polymorphic type information, this is the type deserializer that can handle it

Constructor Detail

MapEntryDeserializerback to summary
public MapEntryDeserializer(JavaType type, KeyDeserializer keyDeser, ValueDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)
MapEntryDeserializerback to summary
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.

MapEntryDeserializerback to summary
protected MapEntryDeserializer(MapEntryDeserializer src, KeyDeserializer keyDeser, ValueDeserializer<Object> valueDeser, TypeDeserializer valueTypeDeser)

Method Detail

createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to finalize setup of this deserializer, when it is known for which property deserializer is needed for.

Annotations
@Override
deserializeback to summary
public Map.Entry<Object, Object> deserialize(JsonParser p, DeserializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.deserialize.

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).

Handling null values (JsonToken.VALUE_NULL)
: Note that this method is never called for the JSON null literal to avoid every deserializer from having to handle null values. Instead, the ValueDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override ValueDeserializer#getNullValue(DeserializationContext) and usually also ValueDeserializer#getNullAccessPattern().

Annotations
@SuppressWarnings:unchecked
@Override
deserializeback to summary
public Map.Entry<Object, Object> deserialize(JsonParser p, DeserializationContext ctxt, Map.Entry<Object, Object> result) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.deserialize.

Doc from tools.jackson.databind.ValueDeserializer.deserialize.

Alternate deserialization method (compared to the most commonly used, 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)

Annotations
@Override
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws JacksonException

Overrides tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

Doc from tools.jackson.databind.deser.std.StdDeserializer.deserializeWithType.

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.

Annotations
@Override
getContentDeserializerback to summary
public ValueDeserializer<Object> getContentDeserializer()

Implements abstract tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Doc from tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentDeserializer.

Accesor for deserializer use for deserializing content values.

Annotations
@Override
getContentTypeback to summary
public JavaType getContentType()

Overrides tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentType.

Doc from tools.jackson.databind.deser.std.ContainerDeserializerBase.getContentType.

Accessor for declared type of contained value elements; either exact type, or one of its supertypes.

Annotations
@Override
logicalTypeback to summary
public LogicalType logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Doc from tools.jackson.databind.ValueDeserializer.logicalType.

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.

Annotations
@Override
withResolvedback to summary
protected MapEntryDeserializer withResolved(KeyDeserializer keyDeser, TypeDeserializer valueTypeDeser, ValueDeserializer<?> valueDeser)

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

Annotations
@SuppressWarnings:unchecked