Top Fields Constructors Methods
tools.jackson.datatype.primitive_collections_base.deser.map

public Class MapDeserializer<T, I, K extends KeyHandler<K>, V extends ValueHandler<V>>

extends ValueDeserializer<T>
Class Inheritance
Imports
java.util.function.Function, tools.jackson.core.JacksonException, .JsonParser, .JsonToken, tools.jackson.databind.*, tools.jackson.databind.jsontype.TypeDeserializer
Author
yawkat

Field Summary

Modifier and TypeField and Description
private final Function<I, T>
finish

private final K
keyHandler

private final TypeHandlerPair<I, K, V>
typeHandlerPair

private final V
valueHandler

Constructor Summary

AccessConstructor and Description
public
MapDeserializer(K keyHandler, V valueHandler, TypeHandlerPair<I, K, V> typeHandlerPair, Function<I, T> finish)

Method Summary

Modifier and TypeMethod and Description
public static <T, I, K extends KeyHandler<K>, V extends ValueHandler<V>> MapDeserializer<T, I, K, V>
create(JavaType keyType, JavaType valueType, TypeHandlerPair<I, K, V> typeHandlerPair, Function<I, T> finish)

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

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.

protected I
createIntermediate()

public T
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.

private void
deserializeEntry(I target, DeserializationContext ctx, String key, JsonParser valueParser)

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

Overrides tools.jackson.databind.ValueDeserializer.deserializeWithType.

Deserialization called when type being deserialized is defined to contain additional type identifier, to allow for correctly instantiating correct subtype.

protected T
finish(I intermediate)

protected MapDeserializer<T, ?, ?, ?>
withResolved(K keyHandler, V valueHandler)

Inherited from tools.jackson.databind.ValueDeserializer:
deserializedeserializeWithTypefindBackReferencegetAbsentValuegetDelegateegetEmptyAccessPatterngetEmptyValuegetKnownPropertyNamesgetNullAccessPatterngetNullValuegetObjectIdReaderhandledTypeisCachablelogicalTypereplaceDelegateeresolvesupportsUpdateunwrappingDeserializer

Field Detail

finishback to summary
private final Function<I, T> finish
keyHandlerback to summary
private final K keyHandler
typeHandlerPairback to summary
private final TypeHandlerPair<I, K, V> typeHandlerPair
valueHandlerback to summary
private final V valueHandler

Constructor Detail

MapDeserializerback to summary
public MapDeserializer(K keyHandler, V valueHandler, TypeHandlerPair<I, K, V> typeHandlerPair, Function<I, T> finish)

Method Detail

createback to summary
public static <T, I, K extends KeyHandler<K>, V extends ValueHandler<V>> MapDeserializer<T, I, K, V> create(JavaType keyType, JavaType valueType, TypeHandlerPair<I, K, V> typeHandlerPair, Function<I, T> finish)
createContextualback to summary
public ValueDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueDeserializer.createContextual.

Doc from tools.jackson.databind.ValueDeserializer.createContextual.

Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property. Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Annotations
@Override
createIntermediateback to summary
protected I createIntermediate()
deserializeback to summary
public T 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
deserializeEntryback to summary
private void deserializeEntry(I target, DeserializationContext ctx, String key, JsonParser valueParser) throws JacksonException
deserializeWithTypeback to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws JacksonException

Overrides tools.jackson.databind.ValueDeserializer.deserializeWithType.

Doc from tools.jackson.databind.ValueDeserializer.deserializeWithType.

Deserialization called when type being deserialized is defined to contain additional type identifier, to allow for correctly instantiating correct subtype. This can be due to annotation on type (or its supertype), or due to global settings without annotations.

Default implementation may work for some types, but ideally subclasses should not rely on current default implementation. Implementation is mostly provided to avoid compilation errors with older code.

Annotations
@Override
finishback to summary
protected T finish(I intermediate)
Annotations
@SuppressWarnings:unchecked
withResolvedback to summary
protected MapDeserializer<T, ?, ?, ?> withResolved(K keyHandler, V valueHandler)