Module tools.jackson.databind

Package tools.jackson.databind.deser.bean

Class BeanDeserializer

java.lang.Object

tools.jackson.databind.ValueDeserializer<T>

tools.jackson.databind.deser.std.StdDeserializer<Object>

tools.jackson.databind.deser.bean.BeanDeserializerBase

tools.jackson.databind.deser.bean.BeanDeserializer

All Implemented Interfaces:

NullValueProvider, ValueInstantiator.Gettable

Direct Known Subclasses:

ThrowableDeserializer

public class BeanDeserializer
extends BeanDeserializerBase

Deserializer class that can deserialize instances of arbitrary bean objects, usually from JSON Object structs,

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.ValueDeserializer

ValueDeserializer.None

Field Summary

Fields

Modifier and Type	Field	Description
protected NameTransformer	_currentlyTransforming	State marker we need in order to avoid infinite recursion for some cases (not very clean, alas, but has to do for now)
protected PropertyNameMatcher	_propNameMatcher
protected SettableBeanProperty[]	_propsByIndex

Fields inherited from class tools.jackson.databind.deser.bean.BeanDeserializerBase

_anySetter, _arrayDelegateDeserializer, _backRefs, _beanProperties, _beanType, _delegateDeserializer, _externalTypeIdHandler, _ignorableProps, _ignoreAllUnknown, _includableProps, _injectables, _needViewProcesing, _nonStandardCreation, _objectIdReader, _propertyBasedCreator, _serializationShape, _subDeserializers, _unwrappedPropertyHandler, _valueInstantiator, _vanillaProcessing, TEMP_PROPERTY_NAME

Fields inherited from class tools.jackson.databind.deser.std.StdDeserializer

_valueClass, _valueType, F_MASK_INT_COERCIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BeanDeserializer(BeanDeserializer src)	Copy-constructor that can be used by sub-classes to allow copy-on-write style copying of settings of an existing instance.
protected	BeanDeserializer(BeanDeserializer src, boolean ignoreAllUnknown)
protected	BeanDeserializer(BeanDeserializer src, Set<String> ignorableProps, Set<String> includableProps)
protected	BeanDeserializer(BeanDeserializer src, BeanPropertyMap props)
protected	BeanDeserializer(BeanDeserializer src, ObjectIdReader oir)
protected	BeanDeserializer(BeanDeserializer src, UnwrappedPropertyHandler unwrapHandler, PropertyBasedCreator propertyBasedCreator, BeanPropertyMap renamedProperties, boolean ignoreAllUnknown)
	BeanDeserializer(BeanDeserializerBuilder builder, BeanDescription.Supplier beanDescRef, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, HashSet<String> ignorableProps, boolean ignoreAllUnknown, Set<String> includableProps, boolean hasViews)	Constructor used by BeanDeserializerBuilder.

Method Summary

Modifier and Type	Method	Description
protected Object	_deserializeFromArray(JsonParser p, DeserializationContext ctxt)	Helper method that allows easy support for array-related coercion features: checks for either empty array, or single-value array-wrapped value (if coercion enabled by CoercionConfigs (since 2.12), and either reports an exception (if no coercion allowed), or returns appropriate result value using coercion mechanism indicated.
protected final Object	_deserializeOther(JsonParser p, DeserializationContext ctxt, JsonToken t)
protected Object	_deserializeUsingPropertyBased(JsonParser p, DeserializationContext ctxt)	Method called to deserialize bean using "property-based creator": this means that a non-default constructor or factory method is called, and then possibly other setters.
protected final Object	_deserializeWithErrorWrapping(JsonParser p, DeserializationContext ctxt, SettableBeanProperty prop)
protected Object	_deserializeWithExternalTypeId(JsonParser p, DeserializationContext ctxt, Object bean, ExternalTypeHandler ext)
protected void	_handleNullFromPropsBasedCreator(JsonParser p, DeserializationContext ctxt, TokenBuffer unknown, List<tools.jackson.databind.deser.bean.BeanDeserializer.BeanReferring> referrings)
protected Object	_handleUnexpectedWithin(JsonParser p, DeserializationContext ctxt, Object bean)	Method called if an unexpected token (other then JsonToken.PROPERTY_NAME) is found after POJO has been instantiated and partially bound.
protected BeanDeserializerBase	asArrayDeserializer()	Fluent factory for creating a variant that can handle POJO output as a JSON Array.
Object	deserialize(JsonParser p, DeserializationContext ctxt)	Main deserialization method for bean-based objects (POJOs).
Object	deserialize(JsonParser p, DeserializationContext ctxt, Object bean)	Secondary deserialization method, called in cases where POJO instance is created as part of deserialization, potentially after collecting some or all of the properties to set.
protected Object	deserializeFromNull(JsonParser p, DeserializationContext ctxt)	Helper method called for rare case of pointing to JsonToken.VALUE_NULL token.
Object	deserializeFromObject(JsonParser p, DeserializationContext ctxt)	General version used when handling needs more advanced features.
protected Object	deserializeUsingPropertyBasedWithExternalTypeId(JsonParser p, DeserializationContext ctxt)
protected Object	deserializeUsingPropertyBasedWithUnwrapped(JsonParser p, DeserializationContext ctxt)
protected Object	deserializeWithExternalTypeId(JsonParser p, DeserializationContext ctxt)
protected Object	deserializeWithExternalTypeId(JsonParser p, DeserializationContext ctxt, Object bean)
protected Object	deserializeWithUnwrapped(JsonParser p, DeserializationContext ctxt)	Method called when there are declared "unwrapped" properties which need special handling
protected Object	deserializeWithUnwrapped(JsonParser p, DeserializationContext ctxt, Object bean)
protected final Object	deserializeWithView(JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView)
protected void	initNameMatcher(DeserializationContext ctxt)
ValueDeserializer<Object>	unwrappingDeserializer(DeserializationContext ctxt, NameTransformer transformer)	Method that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.
BeanDeserializerBase	withBeanProperties(BeanPropertyMap props)	Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.
BeanDeserializer	withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps)
BeanDeserializerBase	withIgnoreAllUnknown(boolean ignoreUnknown)
BeanDeserializer	withObjectIdReader(ObjectIdReader oir)

Methods inherited from class tools.jackson.databind.deser.bean.BeanDeserializerBase

_convertObjectId, _delegateDeserializer, _delegateDeserializer, _findConvertingDeserializer, _findPropertyUnwrapper, _findSubclassDeserializer, _getSetterInfo, _handleByNameInclusion, _handleTypedObjectId, _replaceProperty, _resolvedObjectIdProperty, _resolveInnerClassValuedProperty, _resolveManagedReferenceProperty, _resolveMergeAndNullSettings, createContextual, creatorProperties, deserializeFromBoolean, deserializeFromDouble, deserializeFromEmbedded, deserializeFromNumber, deserializeFromObjectId, deserializeFromObjectUsingNonDefault, deserializeFromString, deserializeWithObjectId, deserializeWithType, findBackReference, findProperty, findProperty, findProperty, getEmptyAccessPattern, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getObjectIdReader, getPropertyCount, getValueInstantiator, getValueType, handledType, handleIgnoredProperty, handlePolymorphic, handleUnknownProperties, handleUnknownProperty, handleUnknownVanilla, hasProperty, hasViews, injectValues, isCachable, isCaseInsensitive, logicalType, properties, resolve, supportsUpdate, wrapAndThrow, wrapInstantiationProblem

Methods inherited from class tools.jackson.databind.deser.std.StdDeserializer

_byteOverflow, _checkBooleanToStringCoercion, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFloatToStringCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkIntToFloatCoercion, _checkIntToStringCoercion, _checkTextualNull, _checkToStringCoercion, _coerceBooleanFromInt, _coercedTypeDesc, _coercedTypeDesc, _coerceIntegral, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _wrapIOFailure, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueType, handleMissingEndArrayForSingle, handleNestedArrayForSingle, isDefaultDeserializer, isDefaultKeyDeserializer

Methods inherited from class tools.jackson.databind.ValueDeserializer

deserializeWithType, getAbsentValue, getDelegatee, getNullValue, replaceDelegatee

Methods inherited from class java.lang.Object

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

Field Details

_propNameMatcher

protected PropertyNameMatcher _propNameMatcher

_propsByIndex

protected SettableBeanProperty[] _propsByIndex

_currentlyTransforming

protected transient volatile NameTransformer _currentlyTransforming

State marker we need in order to avoid infinite recursion for some cases (not very clean, alas, but has to do for now)

Constructor Details

BeanDeserializer

public BeanDeserializer(BeanDeserializerBuilder builder,
 BeanDescription.Supplier beanDescRef,
 BeanPropertyMap properties,
 Map<String,SettableBeanProperty> backRefs,
 HashSet<String> ignorableProps,
 boolean ignoreAllUnknown,
 Set<String> includableProps,
 boolean hasViews)

Constructor used by BeanDeserializerBuilder.

BeanDeserializer

protected BeanDeserializer(BeanDeserializer src)

Copy-constructor that can be used by sub-classes to allow copy-on-write style copying of settings of an existing instance.

BeanDeserializer

protected BeanDeserializer(BeanDeserializer src,
 boolean ignoreAllUnknown)

BeanDeserializer

protected BeanDeserializer(BeanDeserializer src,
 UnwrappedPropertyHandler unwrapHandler,
 PropertyBasedCreator propertyBasedCreator,
 BeanPropertyMap renamedProperties,
 boolean ignoreAllUnknown)

BeanDeserializer

protected BeanDeserializer(BeanDeserializer src,
 ObjectIdReader oir)

BeanDeserializer

protected BeanDeserializer(BeanDeserializer src,
 Set<String> ignorableProps,
 Set<String> includableProps)

BeanDeserializer

protected BeanDeserializer(BeanDeserializer src,
 BeanPropertyMap props)

Method Details

unwrappingDeserializer

public ValueDeserializer<Object> unwrappingDeserializer(DeserializationContext ctxt,
 NameTransformer transformer)

Description copied from class: ValueDeserializer

Method that will return deserializer instance that is able to handle "unwrapped" value instances If no unwrapped instance can be constructed, will simply return this object as-is.

Default implementation just returns 'this' indicating that no unwrapped variant exists

Specified by:

unwrappingDeserializer in class BeanDeserializerBase

withObjectIdReader

public BeanDeserializer withObjectIdReader(ObjectIdReader oir)

Specified by:

withObjectIdReader in class BeanDeserializerBase

withByNameInclusion

public BeanDeserializer withByNameInclusion(Set<String> ignorableProps,
 Set<String> includableProps)

Specified by:

withByNameInclusion in class BeanDeserializerBase

withIgnoreAllUnknown

public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown)

Specified by:

withIgnoreAllUnknown in class BeanDeserializerBase

withBeanProperties

public BeanDeserializerBase withBeanProperties(BeanPropertyMap props)

Description copied from class: BeanDeserializerBase

Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.

Overrides:

withBeanProperties in class BeanDeserializerBase

asArrayDeserializer

protected BeanDeserializerBase asArrayDeserializer()

Description copied from class: BeanDeserializerBase

Fluent factory for creating a variant that can handle POJO output as a JSON Array. Implementations may ignore this request if no such input is possible.

Specified by:

asArrayDeserializer in class BeanDeserializerBase

initNameMatcher

protected void initNameMatcher(DeserializationContext ctxt)

Specified by:

initNameMatcher in class BeanDeserializerBase

deserialize

public Object deserialize(JsonParser p,
 DeserializationContext ctxt)
                   throws JacksonException

Main deserialization method for bean-based objects (POJOs).

Specified by:

deserialize in class ValueDeserializer<Object>

Parameters:

p - Parser used for reading JSON content

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

Returns:

Deserialized value

Throws:

JacksonException

_deserializeOther

protected final Object _deserializeOther(JsonParser p,
 DeserializationContext ctxt,
 JsonToken t)
                                  throws JacksonException

Throws:

JacksonException

deserialize

public Object deserialize(JsonParser p,
 DeserializationContext ctxt,
 Object bean)
                   throws JacksonException

Secondary deserialization method, called in cases where POJO instance is created as part of deserialization, potentially after collecting some or all of the properties to set.

Overrides:

deserialize in class ValueDeserializer<Object>

Throws:

JacksonException

deserializeFromObject

public Object deserializeFromObject(JsonParser p,
 DeserializationContext ctxt)
                             throws JacksonException

General version used when handling needs more advanced features.

Specified by:

deserializeFromObject in class BeanDeserializerBase

Throws:

JacksonException

_deserializeUsingPropertyBased

protected Object _deserializeUsingPropertyBased(JsonParser p,
 DeserializationContext ctxt)
                                         throws JacksonException

Method called to deserialize bean using "property-based creator": this means that a non-default constructor or factory method is called, and then possibly other setters. The trick is that values for creator method need to be buffered, first; and due to non-guaranteed ordering possibly some other properties as well.

Specified by:

_deserializeUsingPropertyBased in class BeanDeserializerBase

Throws:

JacksonException

_deserializeWithErrorWrapping

protected final Object _deserializeWithErrorWrapping(JsonParser p,
 DeserializationContext ctxt,
 SettableBeanProperty prop)
                                              throws DatabindException

Throws:

DatabindException

deserializeFromNull

protected Object deserializeFromNull(JsonParser p,
 DeserializationContext ctxt)
                              throws JacksonException

Helper method called for rare case of pointing to JsonToken.VALUE_NULL token. While this is most often an erroneous condition, there is one specific case with XML handling where polymorphic type with no properties is exposed as such, and should be handled same as empty Object.

Throws:

JacksonException

_deserializeFromArray

protected Object _deserializeFromArray(JsonParser p,
 DeserializationContext ctxt)
                                throws JacksonException

Description copied from class: StdDeserializer

Helper method that allows easy support for array-related coercion features: checks for either empty array, or single-value array-wrapped value (if coercion enabled by CoercionConfigs (since 2.12), and either reports an exception (if no coercion allowed), or returns appropriate result value using coercion mechanism indicated.

This method should NOT be called if Array representation is explicitly supported for type: it should only be called in case it is otherwise unrecognized.

NOTE: in case of unwrapped single element, will handle actual decoding by calling StdDeserializer._deserializeWrappedValue(tools.jackson.core.JsonParser, tools.jackson.databind.DeserializationContext), which by default calls ValueDeserializer.deserialize(JsonParser, DeserializationContext).

Overrides:

_deserializeFromArray in class StdDeserializer<Object>

Throws:

JacksonException

deserializeWithView

protected final Object deserializeWithView(JsonParser p,
 DeserializationContext ctxt,
 Object bean,
 Class<?> activeView)
                                    throws JacksonException

Throws:

JacksonException

deserializeWithUnwrapped

protected Object deserializeWithUnwrapped(JsonParser p,
 DeserializationContext ctxt)
                                   throws JacksonException

Method called when there are declared "unwrapped" properties which need special handling

Throws:

JacksonException

deserializeWithUnwrapped

protected Object deserializeWithUnwrapped(JsonParser p,
 DeserializationContext ctxt,
 Object bean)
                                   throws JacksonException

Throws:

JacksonException

deserializeUsingPropertyBasedWithUnwrapped

protected Object deserializeUsingPropertyBasedWithUnwrapped(JsonParser p,
 DeserializationContext ctxt)
                                                     throws JacksonException

Throws:

JacksonException

deserializeWithExternalTypeId

protected Object deserializeWithExternalTypeId(JsonParser p,
 DeserializationContext ctxt)
                                        throws JacksonException

Throws:

JacksonException

deserializeWithExternalTypeId

protected Object deserializeWithExternalTypeId(JsonParser p,
 DeserializationContext ctxt,
 Object bean)
                                        throws JacksonException

Throws:

JacksonException

_deserializeWithExternalTypeId

protected Object _deserializeWithExternalTypeId(JsonParser p,
 DeserializationContext ctxt,
 Object bean,
 ExternalTypeHandler ext)
                                         throws JacksonException

Throws:

JacksonException

deserializeUsingPropertyBasedWithExternalTypeId

protected Object deserializeUsingPropertyBasedWithExternalTypeId(JsonParser p,
 DeserializationContext ctxt)
                                                          throws JacksonException

Throws:

JacksonException

_handleNullFromPropsBasedCreator

protected void _handleNullFromPropsBasedCreator(JsonParser p,
 DeserializationContext ctxt,
 TokenBuffer unknown,
 List<tools.jackson.databind.deser.bean.BeanDeserializer.BeanReferring> referrings)

_handleUnexpectedWithin

protected Object _handleUnexpectedWithin(JsonParser p,
 DeserializationContext ctxt,
 Object bean)
                                  throws JacksonException

Method called if an unexpected token (other then JsonToken.PROPERTY_NAME) is found after POJO has been instantiated and partially bound.

Throws:

JacksonException

Since:

3.0