Module tools.jackson.databind

Package tools.jackson.databind.deser.bean

Class BuilderBasedDeserializer

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.BuilderBasedDeserializer

All Implemented Interfaces:

NullValueProvider, ValueInstantiator.Gettable

public class BuilderBasedDeserializer
extends BeanDeserializerBase

Class that handles deserialization using a separate Builder class, which is used for data binding and produces actual deserialized value at the end of data binding.

Note on implementation: much of code has been copied from BeanDeserializer; there may be opportunities to refactor this in future.

Nested Class Summary

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

ValueDeserializer.None

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotatedMethod	_buildMethod
protected SettableBeanProperty[]	_propertiesByIndex
protected PropertyNameMatcher	_propertyNameMatcher
protected final JavaType	_targetType	Type that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.

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	BuilderBasedDeserializer(BuilderBasedDeserializer src)	Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.
protected	BuilderBasedDeserializer(BuilderBasedDeserializer src, boolean ignoreAllUnknown)
	BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps)
	BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps, Set<String> includableProps)
	BuilderBasedDeserializer(BuilderBasedDeserializer src, BeanPropertyMap props)
	BuilderBasedDeserializer(BuilderBasedDeserializer src, ObjectIdReader oir)
protected	BuilderBasedDeserializer(BuilderBasedDeserializer src, UnwrappedPropertyHandler unwrapHandler, PropertyBasedCreator pbCreator, BeanPropertyMap renamedProperties, boolean ignoreAllUnknown)
	BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription.Supplier beanDescRef, JavaType targetType, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)	Constructor used by BeanDeserializerBuilder.
	BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription.Supplier beanDescRef, JavaType targetType, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, Set<String> includableProps, boolean hasViews)

Method Summary

Modifier and Type	Method	Description
protected final Object	_deserialize(JsonParser p, DeserializationContext ctxt, Object builder)
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 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 Object	_handleUnexpectedWithin(JsonParser p, DeserializationContext ctxt, Object beanOrBuilder)	Method called if an unexpected token (other then FIELD_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 value)	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.
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 builder, TokenBuffer tokens)
protected final Object	deserializeWithView(JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView)
protected Object	finishBuild(DeserializationContext ctxt, Object builder)
protected void	initNameMatcher(DeserializationContext ctxt)
Boolean	supportsUpdate(DeserializationConfig config)	Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.
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.
BeanDeserializerBase	withByNameInclusion(Set<String> ignorableProps, Set<String> includableProps)
BeanDeserializerBase	withIgnoreAllUnknown(boolean ignoreUnknown)
BeanDeserializerBase	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, 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

_buildMethod

protected final AnnotatedMethod _buildMethod

_targetType

protected final JavaType _targetType

Type that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.

_propertyNameMatcher

protected PropertyNameMatcher _propertyNameMatcher

_propertiesByIndex

protected SettableBeanProperty[] _propertiesByIndex

Constructor Details

BuilderBasedDeserializer

public BuilderBasedDeserializer(BeanDeserializerBuilder builder,
 BeanDescription.Supplier beanDescRef,
 JavaType targetType,
 BeanPropertyMap properties,
 Map<String,SettableBeanProperty> backRefs,
 Set<String> ignorableProps,
 boolean ignoreAllUnknown,
 boolean hasViews)

Constructor used by BeanDeserializerBuilder.

BuilderBasedDeserializer

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

Since:

2.12

BuilderBasedDeserializer

protected BuilderBasedDeserializer(BuilderBasedDeserializer src)

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

BuilderBasedDeserializer

protected BuilderBasedDeserializer(BuilderBasedDeserializer src,
 boolean ignoreAllUnknown)

BuilderBasedDeserializer

protected BuilderBasedDeserializer(BuilderBasedDeserializer src,
 UnwrappedPropertyHandler unwrapHandler,
 PropertyBasedCreator pbCreator,
 BeanPropertyMap renamedProperties,
 boolean ignoreAllUnknown)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 ObjectIdReader oir)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 Set<String> ignorableProps)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 Set<String> ignorableProps,
 Set<String> includableProps)

BuilderBasedDeserializer

public BuilderBasedDeserializer(BuilderBasedDeserializer src,
 BeanPropertyMap props)

Method Details

initNameMatcher

protected void initNameMatcher(DeserializationContext ctxt)

Specified by:

initNameMatcher in class BeanDeserializerBase

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 BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)

Specified by:

withObjectIdReader in class BeanDeserializerBase

withByNameInclusion

public BeanDeserializerBase 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

supportsUpdate

public Boolean supportsUpdate(DeserializationConfig config)

Description copied from class: ValueDeserializer

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 deserializer 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 BeanDeserializerBase

finishBuild

protected Object finishBuild(DeserializationContext ctxt,
 Object builder)
                      throws JacksonException

Throws:

JacksonException

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

deserialize

public Object deserialize(JsonParser p,
 DeserializationContext ctxt,
 Object value)
                   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

Returns:

Builder instance constructed

Throws:

JacksonException

_deserialize

protected final Object _deserialize(JsonParser p,
 DeserializationContext ctxt,
 Object builder)
                             throws JacksonException

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 builder,
 TokenBuffer tokens)
                                   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

deserializeUsingPropertyBasedWithExternalTypeId

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

Throws:

JacksonException

_handleUnexpectedWithin

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

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

Throws:

JacksonException

Since:

3.0