com.fasterxml.jackson.databind.deser.std

Class EnumSetDeserializer

java.lang.Object

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

com.fasterxml.jackson.databind.deser.std.StdDeserializer<EnumSet<?>>

com.fasterxml.jackson.databind.deser.std.EnumSetDeserializer

All Implemented Interfaces:

ContextualDeserializer, Serializable

public class EnumSetDeserializer
extends StdDeserializer<EnumSet<?>>
implements ContextualDeserializer

Standard deserializer for EnumSets.

Note: casting within this class is all messed up -- just could not figure out a way to properly deal with recursive definition of "EnumSet, V>

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 Class<Enum>	_enumClass
protected JsonDeserializer<Enum<?>>	_enumDeserializer
protected JavaType	_enumType

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

_valueClass

Constructor Summary

Constructors

Constructor and Description
EnumSetDeserializer(JavaType enumType, JsonDeserializer<?> deser)

Method Summary

Modifier and Type	Method and Description
JsonDeserializer<?>	createContextual(DeserializationContext ctxt, BeanProperty property) Method called to see if a different (or differently configured) deserializer is needed to deserialize values of specified property.
EnumSet<?>	deserialize(JsonParser jp, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
Object	deserializeWithType(JsonParser jp, DeserializationContext ctxt, TypeDeserializer typeDeserializer) Base implementation that does not assume specific type inclusion mechanism.
boolean	isCachable() Because of costs associated with constructing Enum resolvers, let's cache instances by default.
EnumSetDeserializer	withDeserializer(JsonDeserializer<?> deser)

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, getValueType, handledType, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble

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

deserialize, findBackReference, getDelegatee, getEmptyValue, getKnownPropertyNames, getNullValue, getObjectIdReader, replaceDelegatee, unwrappingDeserializer

Methods inherited from class java.lang.Object

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

Field Detail

_enumType

protected final JavaType _enumType

_enumClass

protected final Class<Enum> _enumClass

_enumDeserializer

protected JsonDeserializer<Enum<?>> _enumDeserializer

Constructor Detail

EnumSetDeserializer

public EnumSetDeserializer(JavaType enumType,
                           JsonDeserializer<?> deser)

Method Detail

withDeserializer

public EnumSetDeserializer withDeserializer(JsonDeserializer<?> deser)

isCachable

public boolean isCachable()

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

Overrides:

isCachable in class JsonDeserializer<EnumSet<?>>

createContextual

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

Description copied from interface: ContextualDeserializer

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.

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

deserialize

public EnumSet<?> deserialize(JsonParser jp,
                              DeserializationContext ctxt)
                       throws IOException,
                              JsonProcessingException

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<EnumSet<?>>

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

JsonProcessingException

deserializeWithType

public Object deserializeWithType(JsonParser jp,
                                  DeserializationContext ctxt,
                                  TypeDeserializer typeDeserializer)
                           throws IOException,
                                  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<EnumSet<?>>

typeDeserializer - Deserializer to use for handling type information

Throws:

IOException

JsonProcessingException