Class BuilderBasedDeserializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonDeserializer<T>
-
- com.fasterxml.jackson.databind.deser.std.StdDeserializer<java.lang.Object>
-
- com.fasterxml.jackson.databind.deser.BeanDeserializerBase
-
- com.fasterxml.jackson.databind.deser.BuilderBasedDeserializer
-
- All Implemented Interfaces:
ContextualDeserializer
,NullValueProvider
,ResolvableDeserializer
,ValueInstantiator.Gettable
,java.io.Serializable
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.- 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 Description protected AnnotatedMethod
_buildMethod
protected JavaType
_targetType
Type that the builder will produce, target type; as opposed to `handledType()` which refers to Builder class.-
Fields inherited from class com.fasterxml.jackson.databind.deser.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 com.fasterxml.jackson.databind.deser.std.StdDeserializer
_valueClass, _valueType, F_MASK_ACCEPT_ARRAYS, F_MASK_INT_COERCIONS
-
-
Constructor Summary
Constructors Modifier Constructor Description BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, java.util.Map<java.lang.String,SettableBeanProperty> backRefs, java.util.Set<java.lang.String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)
Deprecated.Since 2.9BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, java.util.Map<java.lang.String,SettableBeanProperty> backRefs, java.util.Set<java.lang.String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)
Constructor used byBeanDeserializerBuilder
.BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, java.util.Map<java.lang.String,SettableBeanProperty> backRefs, java.util.Set<java.lang.String> ignorableProps, boolean ignoreAllUnknown, java.util.Set<java.lang.String> includableProps, boolean hasViews)
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, BeanPropertyMap props)
BuilderBasedDeserializer(BuilderBasedDeserializer src, ObjectIdReader oir)
protected
BuilderBasedDeserializer(BuilderBasedDeserializer src, NameTransformer unwrapper)
BuilderBasedDeserializer(BuilderBasedDeserializer src, java.util.Set<java.lang.String> ignorableProps)
BuilderBasedDeserializer(BuilderBasedDeserializer src, java.util.Set<java.lang.String> ignorableProps, java.util.Set<java.lang.String> includableProps)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.lang.Object
_deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object builder)
protected java.lang.Object
_deserializeFromArray(com.fasterxml.jackson.core.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 byCoercionConfigs
(since 2.12), and either reports an exception (if no coercion allowed), or returns appropriate result value using coercion mechanism indicated.protected java.lang.Object
_deserializeUsingPropertyBased(com.fasterxml.jackson.core.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 BeanDeserializerBase
asArrayDeserializer()
Fluent factory for creating a variant that can handle POJO output as a JSON Array.java.lang.Object
deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)
Main deserialization method for bean-based objects (POJOs).java.lang.Object
deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.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.java.lang.Object
deserializeFromObject(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)
General version used when handling needs more advanced features.protected java.lang.Object
deserializeUsingPropertyBasedWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)
protected java.lang.Object
deserializeUsingPropertyBasedWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)
protected java.lang.Object
deserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)
protected java.lang.Object
deserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object bean)
protected java.lang.Object
deserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)
Method called when there are declared "unwrapped" properties which need special handlingprotected java.lang.Object
deserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object builder, TokenBuffer tokens)
protected java.lang.Object
deserializeWithView(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object bean, java.lang.Class<?> activeView)
protected java.lang.Object
finishBuild(DeserializationContext ctxt, java.lang.Object builder)
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.JsonDeserializer<java.lang.Object>
unwrappingDeserializer(NameTransformer unwrapper)
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(java.util.Set<java.lang.String> ignorableProps, java.util.Set<java.lang.String> includableProps)
BeanDeserializerBase
withIgnoreAllUnknown(boolean ignoreUnknown)
BeanDeserializerBase
withObjectIdReader(ObjectIdReader oir)
-
Methods inherited from class com.fasterxml.jackson.databind.deser.BeanDeserializerBase
_convertObjectId, _delegateDeserializer, _findPropertyUnwrapper, _findSubclassDeserializer, _handleByNameInclusion, _handleTypedObjectId, _replaceProperty, _resolvedObjectIdProperty, _resolveInnerClassValuedProperty, _resolveManagedReferenceProperty, _resolveMergeAndNullSettings, createContextual, creatorProperties, deserializeFromArray, deserializeFromBoolean, deserializeFromDouble, deserializeFromEmbedded, deserializeFromNumber, deserializeFromObjectId, deserializeFromObjectUsingNonDefault, deserializeFromString, deserializeWithObjectId, deserializeWithType, findBackReference, findConvertingDeserializer, findProperty, findProperty, findProperty, getBeanClass, getEmptyAccessPattern, getEmptyValue, getKnownPropertyNames, getNullAccessPattern, getObjectIdReader, getPropertyCount, getValueInstantiator, getValueType, handledType, handleIgnoredProperty, handlePolymorphic, handleUnknownProperties, handleUnknownProperty, handleUnknownVanilla, hasProperty, hasViews, injectValues, isCachable, isCaseInsensitive, logicalType, properties, replaceProperty, resolve, withIgnorableProperties, wrapAndThrow, wrapInstantiationProblem
-
Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
_byteOverflow, _checkCoercionFail, _checkDoubleSpecialValue, _checkFloatSpecialValue, _checkFloatToIntCoercion, _checkFromStringCoercion, _checkFromStringCoercion, _checkTextualNull, _coerceBooleanFromInt, _coercedTypeDesc, _coerceEmptyString, _coerceIntegral, _coerceNullToken, _coerceTextualNull, _deserializeFromEmpty, _deserializeFromEmptyString, _deserializeFromString, _deserializeWrappedValue, _failDoubleToIntCoercion, _findCoercionFromBlankString, _findCoercionFromEmptyArray, _findCoercionFromEmptyString, _findNullProvider, _hasTextualNull, _intOverflow, _isBlank, _isEmptyOrTextualNull, _isFalse, _isIntNumber, _isNaN, _isNegInf, _isPosInf, _isTrue, _neitherNull, _nonNullNumber, _parseBoolean, _parseBooleanFromInt, _parseBooleanPrimitive, _parseBooleanPrimitive, _parseBytePrimitive, _parseDate, _parseDate, _parseDateFromArray, _parseDouble, _parseDoublePrimitive, _parseDoublePrimitive, _parseFloatPrimitive, _parseFloatPrimitive, _parseInteger, _parseIntPrimitive, _parseIntPrimitive, _parseLong, _parseLongPrimitive, _parseLongPrimitive, _parseShortPrimitive, _parseString, _reportFailedNullCoerce, _shortOverflow, _verifyEndArrayForSingle, _verifyNullForPrimitive, _verifyNullForPrimitiveCoercion, _verifyNullForScalarCoercion, _verifyNumberForScalarCoercion, _verifyStringForScalarCoercion, findContentNullProvider, findContentNullStyle, findConvertingContentDeserializer, findDeserializer, findFormatFeature, findFormatOverrides, findValueNullProvider, getValueClass, getValueType, handleMissingEndArrayForSingle, isDefaultDeserializer, isDefaultKeyDeserializer
-
Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
deserializeWithType, getDelegatee, getEmptyValue, getNullValue, getNullValue, replaceDelegatee
-
-
-
-
Field Detail
-
_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.- Since:
- 2.9
-
-
Constructor Detail
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, java.util.Map<java.lang.String,SettableBeanProperty> backRefs, java.util.Set<java.lang.String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)
Constructor used byBeanDeserializerBuilder
.
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, java.util.Map<java.lang.String,SettableBeanProperty> backRefs, java.util.Set<java.lang.String> ignorableProps, boolean ignoreAllUnknown, java.util.Set<java.lang.String> includableProps, boolean hasViews)
- Since:
- 2.12
-
BuilderBasedDeserializer
@Deprecated public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, java.util.Map<java.lang.String,SettableBeanProperty> backRefs, java.util.Set<java.lang.String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)
Deprecated.Since 2.9
-
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, NameTransformer unwrapper)
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BuilderBasedDeserializer src, ObjectIdReader oir)
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BuilderBasedDeserializer src, java.util.Set<java.lang.String> ignorableProps)
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BuilderBasedDeserializer src, java.util.Set<java.lang.String> ignorableProps, java.util.Set<java.lang.String> includableProps)
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BuilderBasedDeserializer src, BeanPropertyMap props)
-
-
Method Detail
-
unwrappingDeserializer
public JsonDeserializer<java.lang.Object> unwrappingDeserializer(NameTransformer unwrapper)
Description copied from class:JsonDeserializer
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 classBeanDeserializerBase
-
withObjectIdReader
public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)
- Specified by:
withObjectIdReader
in classBeanDeserializerBase
-
withByNameInclusion
public BeanDeserializerBase withByNameInclusion(java.util.Set<java.lang.String> ignorableProps, java.util.Set<java.lang.String> includableProps)
- Specified by:
withByNameInclusion
in classBeanDeserializerBase
-
withIgnoreAllUnknown
public BeanDeserializerBase withIgnoreAllUnknown(boolean ignoreUnknown)
- Specified by:
withIgnoreAllUnknown
in classBeanDeserializerBase
-
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 classBeanDeserializerBase
-
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 classBeanDeserializerBase
-
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 beBoolean.FALSE
if update is not supported at all (immutable values);Boolean.TRUE
if update should usually work (regular POJOs, for example), ornull
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 ifBoolean.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 classBeanDeserializerBase
-
finishBuild
protected java.lang.Object finishBuild(DeserializationContext ctxt, java.lang.Object builder) throws java.io.IOException
- Throws:
java.io.IOException
-
deserialize
public java.lang.Object deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
Main deserialization method for bean-based objects (POJOs).- Specified by:
deserialize
in classJsonDeserializer<java.lang.Object>
- Parameters:
p
- Parsed used for reading JSON contentctxt
- Context that can be used to access information about this deserialization activity.- Returns:
- Deserialized value
- Throws:
java.io.IOException
-
deserialize
public java.lang.Object deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object value) throws java.io.IOException
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 classJsonDeserializer<java.lang.Object>
- Throws:
java.io.IOException
-
deserializeFromObject
public java.lang.Object deserializeFromObject(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
General version used when handling needs more advanced features.- Specified by:
deserializeFromObject
in classBeanDeserializerBase
- Throws:
java.io.IOException
-
_deserializeUsingPropertyBased
protected java.lang.Object _deserializeUsingPropertyBased(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
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 classBeanDeserializerBase
- Returns:
- Builder instance constructed
- Throws:
java.io.IOException
-
_deserialize
protected final java.lang.Object _deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object builder) throws java.io.IOException
- Throws:
java.io.IOException
-
_deserializeFromArray
protected java.lang.Object _deserializeFromArray(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
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 byCoercionConfigs
(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(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext)
, which by default callsJsonDeserializer.deserialize(JsonParser, DeserializationContext)
.- Overrides:
_deserializeFromArray
in classStdDeserializer<java.lang.Object>
- Throws:
java.io.IOException
-
deserializeWithView
protected final java.lang.Object deserializeWithView(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object bean, java.lang.Class<?> activeView) throws java.io.IOException
- Throws:
java.io.IOException
-
deserializeWithUnwrapped
protected java.lang.Object deserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
Method called when there are declared "unwrapped" properties which need special handling- Throws:
java.io.IOException
-
deserializeUsingPropertyBasedWithUnwrapped
protected java.lang.Object deserializeUsingPropertyBasedWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
- Throws:
java.io.IOException
-
deserializeWithUnwrapped
protected java.lang.Object deserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object builder, TokenBuffer tokens) throws java.io.IOException
- Throws:
java.io.IOException
-
deserializeWithExternalTypeId
protected java.lang.Object deserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
- Throws:
java.io.IOException
-
deserializeWithExternalTypeId
protected java.lang.Object deserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, java.lang.Object bean) throws java.io.IOException
- Throws:
java.io.IOException
-
deserializeUsingPropertyBasedWithExternalTypeId
protected java.lang.Object deserializeUsingPropertyBasedWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws java.io.IOException
- Throws:
java.io.IOException
-
-