Jackson 2.18.2 · com.fasterxml.jackson.datatype.pcollections.deser.PCollectionsMapDeserializer

Modifier and Type	Field and Description
protected KeyDeserializer	_keyDeserializer Key deserializer used, if not null.
protected final MapType	_mapType
protected final TypeDeserializer	_typeDeserializerForValue If value instances have polymorphic type information, this is the type deserializer that can handle it
protected JsonDeserializer<?>	_valueDeserializer Value deserializer.

Access	Constructor and Description
protected	PCollectionsMapDeserializer(MapType type, KeyDeserializer keyDeser, TypeDeserializer typeDeser, JsonDeserializer<?> deser)

Method Summary

Modifier and Type	Method and Description
protected T	_deserializeEntries(JsonParser p, DeserializationContext ctxt)
protected T	_handleNull(DeserializationContext ctxt, Object key, JsonDeserializer<?> valueDeser, T map) Overridable helper method called when a JSON null value is encountered.
public JsonDeserializer<?>	createContextual(DeserializationContext Deserialization context to access configuration, additional deserializers that may be needed by this deserializer ctxt, BeanProperty 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 cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is) property) Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual. Method called to finalize setup of this deserializer, after deserializer itself has been registered.
protected abstract T	createEmptyMap()
public T	deserialize(JsonParser Parser used for reading JSON content p, DeserializationContext Context that can be used to access information about this deserialization activity. ctxt) Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize. Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
public Object	deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer Deserializer to use for handling type information typeDeserializer) Overrides com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType. Base implementation that does not assume specific type inclusion mechanism.
public LogicalType	logicalType() Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType. Method for accessing logical type of values this deserializer produces.
public abstract PCollectionsMapDeserializer<T>	withResolved(KeyDeserializer keyDeser, TypeDeserializer typeDeser, JsonDeserializer<?> valueDeser) Overridable fluent factory method used for creating contextual instances.

Inherited from com.fasterxml.jackson.databind.JsonDeserializer:: deserialize deserializeWithType findBackReference getAbsentValue getDelegatee getEmptyAccessPattern getEmptyValue getEmptyValue getKnownPropertyNames getNullAccessPattern getNullValue getNullValue getObjectIdReader handledType isCachable replaceDelegatee supportsUpdate unwrappingDeserializer

_keyDeserializer	back to summary
protected KeyDeserializer _keyDeserializer Key deserializer used, if not null. If null, String from JSON content is used as is.

_mapType	back to summary
protected final MapType _mapType

_typeDeserializerForValue	back to summary
protected final TypeDeserializer _typeDeserializerForValue If value instances have polymorphic type information, this is the type deserializer that can handle it

_valueDeserializer	back to summary
protected JsonDeserializer<?> _valueDeserializer Value deserializer.

PCollectionsMapDeserializer	back to summary
protected PCollectionsMapDeserializer(MapType type, KeyDeserializer keyDeser, TypeDeserializer typeDeser, JsonDeserializer<?> deser)

Method Detail

_deserializeEntries	back to summary
protected T _deserializeEntries(JsonParser p, DeserializationContext ctxt) throws IOException

_handleNull	back to summary
protected T _handleNull(DeserializationContext ctxt, Object key, JsonDeserializer<?> valueDeser, T map) throws IOException Overridable helper method called when a JSON null value is encountered. Since PCollections Maps typically do not allow null values, special handling is needed; default is to simply ignore and skip such values, but alternative could be to throw an exception.

createContextual	back to summary
public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual. Method called to finalize setup of this deserializer, after deserializer itself has been registered. This is needed to handle recursive and transitive dependencies. Parameters ctxt:DeserializationContext Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual. Deserialization context to access configuration, additional deserializers that may be needed by this deserializer property:BeanProperty Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual. 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 cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is) Returns:JsonDeserializer<?> Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual. Deserializer to use for deserializing values of specified property; may be this instance or a new instance. Annotations @Override

createContextual

back to summary

public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Method called to finalize setup of this deserializer, after deserializer itself has been registered. This is needed to handle recursive and transitive dependencies.

Parameters

ctxt:DeserializationContext

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

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

property:BeanProperty

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

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 cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)

Returns:JsonDeserializer<?>

Doc from com.fasterxml.jackson.databind.deser.ContextualDeserializer.createContextual.

Deserializer to use for deserializing values of specified property; may be this instance or a new instance.

Annotations

@Override

createEmptyMap	back to summary
protected abstract T createEmptyMap()

deserialize back to summary

deserialize	back to summary
public T deserialize(JsonParser p, DeserializationContext ctxt) throws IOException Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize. Doc from com.fasterxml.jackson.databind.JsonDeserializer.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 `JsonDeserializer#getNullValue(DeserializationContext)` method is called to produce a null value. To influence null handling, custom deserializers should override `JsonDeserializer#getNullValue(DeserializationContext)` and usually also `JsonDeserializer#getNullAccessPattern()`. Parameters p:JsonParser Parser used for reading JSON content ctxt:DeserializationContext Context that can be used to access information about this deserialization activity. Returns:T Deserialized value Annotations @SuppressWarnings:unchecked @Override

public T deserialize(JsonParser p, DeserializationContext ctxt) throws IOException

Implements abstract com.fasterxml.jackson.databind.JsonDeserializer.deserialize.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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 JsonDeserializer#getNullValue(DeserializationContext) method is called to produce a null value. To influence null handling, custom deserializers should override JsonDeserializer#getNullValue(DeserializationContext) and usually also JsonDeserializer#getNullAccessPattern().

Parameters

p:JsonParser: Parser used for reading JSON content
ctxt:DeserializationContext: Context that can be used to access information about this deserialization activity.

Returns:T

Deserialized value

Annotations

@SuppressWarnings:unchecked
@Override

deserializeWithType	back to summary
public Object deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) throws IOException Overrides com.fasterxml.jackson.databind.JsonDeserializer.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. Parameters typeDeserializer:TypeDeserializer Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType. Deserializer to use for handling type information Annotations @Override

deserializeWithType

back to summary

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

Overrides com.fasterxml.jackson.databind.JsonDeserializer.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.

Parameters

typeDeserializer:TypeDeserializer

Doc from com.fasterxml.jackson.databind.JsonDeserializer.deserializeWithType.

Deserializer to use for handling type information

Annotations

@Override

logicalType back to summary

logicalType	back to summary
public LogicalType logicalType() Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType. Doc from com.fasterxml.jackson.databind.JsonDeserializer.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. Returns:LogicalType Logical type of values this deserializer produces, if known; `null` if not Annotations @Override

public LogicalType logicalType()

Overrides com.fasterxml.jackson.databind.JsonDeserializer.logicalType.

Doc from com.fasterxml.jackson.databind.JsonDeserializer.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.

Returns:LogicalType

Logical type of values this deserializer produces, if known; null if not

Annotations

@Override

withResolved	back to summary
public abstract PCollectionsMapDeserializer<T> withResolved(KeyDeserializer keyDeser, TypeDeserializer typeDeser, JsonDeserializer<?> valueDeser) Overridable fluent factory method used for creating contextual instances.

public abstract Class PCollectionsMapDeserializer<T extends PMap<Object, Object>>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail