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

public Class EnumMapDeserializer

extends ContainerDeserializerBase<EnumMap<?, ?>>
Class Inheritance
Annotations
@SuppressWarnings:unchecked, rawtypes
Imports
java.util.*, tools.jackson.core.*, tools.jackson.databind.*, tools.jackson.databind.cfg.EnumFeature, tools.jackson.databind.deser.*, tools.jackson.databind.deser.bean.PropertyBasedCreator, .PropertyValueBuffer, tools.jackson.databind.deser.std.ContainerDeserializerBase, tools.jackson.databind.jsontype.TypeDeserializer, tools.jackson.databind.type.LogicalType

Deserializer for EnumMap values.

Note

casting within this class is all messed up -- just could not figure out a way to properly deal with recursive definition of EnumMap<K extends Enum<K>, V>

Field Summary

Modifier and TypeField and Description
protected ValueDeserializer<Object>
_delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

protected final Class<?>
protected KeyDeserializer
protected PropertyBasedCreator
_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.

protected ValueDeserializer<Object>
protected final ValueInstantiator
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

Method Summary

Modifier and TypeMethod and Description
protected Object
_deserializeNoNullChecks(JsonParser p, DeserializationContext ctxt)

Deserialize the content of the map.

public EnumMap<?, ?>
protected EnumMap<?, ?>
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 EnumMap<?, ?>
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 EnumMap<?, ?>
deserialize(JsonParser p, DeserializationContext ctxt, EnumMap<K extends Enum<K>, V> 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 Object
getEmptyValue(DeserializationContext ctxt)

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

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).

public ValueInstantiator
public boolean
isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

Because of costs associated with constructing Enum resolvers, let's cache instances by default.

public LogicalType
logicalType()

Overrides tools.jackson.databind.ValueDeserializer.logicalType.

Method for accessing logical type of values this deserializer produces.

public void
resolve(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.resolve.

Method called after deserializer instance has been constructed (and registered as necessary by provider objects), but before it has returned it to the caller.

public EnumMapDeserializer
withResolved(KeyDeserializer keyDeserializer, ValueDeserializer<?> valueDeserializer, TypeDeserializer valueTypeDeser, NullValueProvider nuller)

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

Field Detail

_delegateDeserializerback to summary
protected ValueDeserializer<Object> _delegateDeserializer

Deserializer that is used iff delegate-based creator is to be used for deserializing from JSON Object.

_enumClassback to summary
protected final Class<?> _enumClass
_keyDeserializerback to summary
protected KeyDeserializer _keyDeserializer
_propertyBasedCreatorback to summary
protected PropertyBasedCreator _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.

_valueDeserializerback to summary
protected ValueDeserializer<Object> _valueDeserializer
_valueInstantiatorback to summary
protected final ValueInstantiator _valueInstantiator
_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

EnumMapDeserializerback to summary
public EnumMapDeserializer(JavaType mapType, ValueInstantiator valueInst, KeyDeserializer keyDeser, ValueDeserializer<?> valueDeser, TypeDeserializer vtd, NullValueProvider nuller)
EnumMapDeserializerback to summary
protected EnumMapDeserializer(EnumMapDeserializer base, KeyDeserializer keyDeser, ValueDeserializer<?> valueDeser, TypeDeserializer vtd, NullValueProvider nuller)

Method Detail

_deserializeNoNullChecksback to summary
protected Object _deserializeNoNullChecks(JsonParser p, DeserializationContext ctxt) throws JacksonException

Deserialize the content of the map. If _valueTypeDeserializer is null, use _valueDeserializer.deserialize; if non-null, use _valueDeserializer.deserializeWithType to deserialize value. This method only performs deserialization and does not consider _skipNullValues, _nullProvider, etc.

Since
2.19.2
_deserializeUsingPropertiesback to summary
public EnumMap<?, ?> _deserializeUsingProperties(JsonParser p, DeserializationContext ctxt) throws JacksonException
constructMapback to summary
protected EnumMap<?, ?> constructMap(DeserializationContext ctxt)
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 EnumMap<?, ?> 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
@Override
deserializeback to summary
public EnumMap<?, ?> deserialize(JsonParser p, DeserializationContext ctxt, EnumMap<K extends Enum<K>, V> 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
getEmptyValueback to summary
public Object getEmptyValue(DeserializationContext ctxt)

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

Doc from tools.jackson.databind.ValueDeserializer.getEmptyValue.

Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as getNullValue (which in turn is usually simply Java null), but it can be overridden for specific types. Or, if type should never be converted from empty String, method can also throw an exception.

This method may be called once, or multiple times, depending on what getEmptyAccessPattern() returns.

Default implementation simply calls getNullValue and returns value.

Annotations
@Override
getValueInstantiatorback to summary
public ValueInstantiator getValueInstantiator()

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

Implements tools.jackson.databind.deser.ValueInstantiator.Gettable.getValueInstantiator.

Annotations
@Override
isCachableback to summary
public boolean isCachable()

Overrides tools.jackson.databind.ValueDeserializer.isCachable.

Because of costs associated with constructing Enum resolvers, let's cache instances by default.

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
resolveback to summary
public void resolve(DeserializationContext ctxt)

Overrides tools.jackson.databind.ValueDeserializer.resolve.

Doc from tools.jackson.databind.ValueDeserializer.resolve.

Method called after deserializer instance has been constructed (and registered as necessary by provider objects), but before it has returned it to the caller. Called object can then resolve its dependencies to other types, including self-references (direct or indirect).

Annotations
@Override
withResolvedback to summary
public EnumMapDeserializer withResolved(KeyDeserializer keyDeserializer, ValueDeserializer<?> valueDeserializer, TypeDeserializer valueTypeDeser, NullValueProvider nuller)