com.fasterxml.jackson.databind.deser.std

Class FactoryBasedEnumDeserializer

java.lang.Object

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

com.fasterxml.jackson.databind.deser.std.StdDeserializer<java.lang.Object>

com.fasterxml.jackson.databind.deser.std.FactoryBasedEnumDeserializer

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, java.io.Serializable

class FactoryBasedEnumDeserializer
extends StdDeserializer<java.lang.Object>
implements ContextualDeserializer

Deserializer that uses a single-String static factory method for locating Enum values by String id.

Since:

2.8 (as stand-alone class; was static inner class of EnumDeserializer

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 SettableBeanProperty[]	_creatorProps
protected JsonDeserializer<?>	_deser
protected AnnotatedMethod	_factory
protected boolean	_hasArgs
protected JavaType	_inputType
private PropertyBasedCreator	_propCreator Lazily instantiated property-based creator.
protected ValueInstantiator	_valueInstantiator
private static long	serialVersionUID

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

_valueClass, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
	FactoryBasedEnumDeserializer(java.lang.Class<?> cls, AnnotatedMethod f)
	FactoryBasedEnumDeserializer(java.lang.Class<?> cls, AnnotatedMethod f, JavaType paramType, ValueInstantiator valueInstantiator, SettableBeanProperty[] creatorProps)
protected	FactoryBasedEnumDeserializer(FactoryBasedEnumDeserializer base, JsonDeserializer<?> deser)

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	_deserializeWithErrorWrapping(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, SettableBeanProperty prop)
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.
java.lang.Object	deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) Method that can be called to ask implementation to deserialize JSON content into the value type this serializer handles.
protected java.lang.Object	deserializeEnumUsingPropertyBased(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, PropertyBasedCreator creator)
java.lang.Object	deserializeWithType(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer) Base implementation that does not assume specific type inclusion mechanism.
boolean	isCachable() Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).
java.lang.Boolean	supportsUpdate(DeserializationConfig config) Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.
private java.lang.Throwable	throwOrReturnThrowable(java.lang.Throwable t, DeserializationContext ctxt)
protected java.lang.Object	wrapAndThrow(java.lang.Throwable t, java.lang.Object bean, java.lang.String fieldName, DeserializationContext ctxt)

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

_byteOverflow, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromArray, _deserializeFromEmpty, _deserializeWrappedValue, _failDoubleToIntCoercion, _findNullProvider, _hasTextualNull, _intOverflow, _isEmptyOrTextualNull, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _neitherNull, _nonNullNumber, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseIntPrimitive, _parseIntPrimitive, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueType, handledType, handleMissingEndArrayForSingle, handleUnknownProperty, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble

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

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

_inputType

protected final JavaType _inputType

_hasArgs

protected final boolean _hasArgs

_factory

protected final AnnotatedMethod _factory

_deser

protected final JsonDeserializer<?> _deser

_valueInstantiator

protected final ValueInstantiator _valueInstantiator

_creatorProps

protected final SettableBeanProperty[] _creatorProps

_propCreator

private transient PropertyBasedCreator _propCreator

Lazily instantiated property-based creator.

Since:

2.8

Constructor Detail

FactoryBasedEnumDeserializer

public FactoryBasedEnumDeserializer(java.lang.Class<?> cls,
                                    AnnotatedMethod f,
                                    JavaType paramType,
                                    ValueInstantiator valueInstantiator,
                                    SettableBeanProperty[] creatorProps)

FactoryBasedEnumDeserializer

public FactoryBasedEnumDeserializer(java.lang.Class<?> cls,
                                    AnnotatedMethod f)

Since:

2.8

FactoryBasedEnumDeserializer

protected FactoryBasedEnumDeserializer(FactoryBasedEnumDeserializer base,
                                       JsonDeserializer<?> deser)

Method Detail

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 cannot 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

supportsUpdate

public java.lang.Boolean supportsUpdate(DeserializationConfig config)

Description copied from class: JsonDeserializer

Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not. Return value should either be Boolean.FALSE if update is not supported at all (immutable values); Boolean.TRUE if update should usually work (regular POJOs, for example), or null if this is either not known, or may sometimes work.

Information gathered is typically used to either prevent merging update for property (either by skipping, if based on global defaults; or by exception during deserialization construction if explicit attempt made) if Boolean.FALSE returned, or inclusion if Boolean.TRUE is specified. If "unknown" case (null returned) behavior is to exclude property if global defaults used; or to allow if explicit per-type or property merging is defined.

Default implementation returns null to allow explicit per-type or per-property attempts.

Overrides:

supportsUpdate in class JsonDeserializer<java.lang.Object>

isCachable

public boolean isCachable()

Description copied from class: JsonDeserializer

Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).

Note that cached instances are still resolved on per-property basis, if instance implements ResolvableDeserializer: cached instance is just as the base. This means that in most cases it is safe to cache instances; however, it only makes sense to cache instances if instantiation is expensive, or if instances are heavy-weight.

Default implementation returns false, to indicate that no caching is done.

Overrides:

isCachable in class JsonDeserializer<java.lang.Object>

deserialize

public java.lang.Object deserialize(com.fasterxml.jackson.core.JsonParser p,
                                    DeserializationContext ctxt)
                             throws java.io.IOException

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 (p.getCurrentToken() == 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).

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<java.lang.Object>

Parameters:

p - Parsed used for reading JSON content

ctxt - Context that can be used to access information about this deserialization activity.

Returns:

Deserialized value

Throws:

java.io.IOException

deserializeWithType

public java.lang.Object deserializeWithType(com.fasterxml.jackson.core.JsonParser p,
                                            DeserializationContext ctxt,
                                            TypeDeserializer typeDeserializer)
                                     throws java.io.IOException

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<java.lang.Object>

typeDeserializer - Deserializer to use for handling type information

Throws:

java.io.IOException

deserializeEnumUsingPropertyBased

protected java.lang.Object deserializeEnumUsingPropertyBased(com.fasterxml.jackson.core.JsonParser p,
                                                             DeserializationContext ctxt,
                                                             PropertyBasedCreator creator)
                                                      throws java.io.IOException

Throws:

java.io.IOException

_deserializeWithErrorWrapping

protected final java.lang.Object _deserializeWithErrorWrapping(com.fasterxml.jackson.core.JsonParser p,
                                                               DeserializationContext ctxt,
                                                               SettableBeanProperty prop)
                                                        throws java.io.IOException

Throws:

java.io.IOException

wrapAndThrow

protected java.lang.Object wrapAndThrow(java.lang.Throwable t,
                                        java.lang.Object bean,
                                        java.lang.String fieldName,
                                        DeserializationContext ctxt)
                                 throws java.io.IOException

Throws:

java.io.IOException

throwOrReturnThrowable

private java.lang.Throwable throwOrReturnThrowable(java.lang.Throwable t,
                                                   DeserializationContext ctxt)
                                            throws java.io.IOException

Throws:

java.io.IOException