Class BuilderBasedDeserializer
- java.lang.Object
-
- com.fasterxml.jackson.databind.JsonDeserializer<T>
-
- com.fasterxml.jackson.databind.deser.std.StdDeserializer<Object>
-
- com.fasterxml.jackson.databind.deser.BeanDeserializerBase
-
- com.fasterxml.jackson.databind.deser.BuilderBasedDeserializer
-
- All Implemented Interfaces:
ContextualDeserializer,NullValueProvider,ResolvableDeserializer,ValueInstantiator.Gettable,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_buildMethodprotected JavaType_targetTypeType 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, _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, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)Deprecated.Since 2.9BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)Constructor used byBeanDeserializerBuilder.protectedBuilderBasedDeserializer(BuilderBasedDeserializer src)Copy-constructor that can be used by sub-classes to allow copy-on-write styling copying of settings of an existing instance.protectedBuilderBasedDeserializer(BuilderBasedDeserializer src, boolean ignoreAllUnknown)BuilderBasedDeserializer(BuilderBasedDeserializer src, BeanPropertyMap props)BuilderBasedDeserializer(BuilderBasedDeserializer src, ObjectIdReader oir)protectedBuilderBasedDeserializer(BuilderBasedDeserializer src, NameTransformer unwrapper)BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Object_deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object builder)protected 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 BeanDeserializerBaseasArrayDeserializer()Fluent factory for creating a variant that can handle POJO output as a JSON Array.Objectdeserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)Main deserialization method for bean-based objects (POJOs).Objectdeserialize(com.fasterxml.jackson.core.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.ObjectdeserializeFromObject(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)General version used when handling needs more advanced features.protected ObjectdeserializeUsingPropertyBasedWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)protected ObjectdeserializeUsingPropertyBasedWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)protected ObjectdeserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)protected ObjectdeserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object bean)protected ObjectdeserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt)Method called when there are declared "unwrapped" properties which need special handlingprotected ObjectdeserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object builder, TokenBuffer tokens)protected ObjectdeserializeWithView(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView)protected ObjectfinishBuild(DeserializationContext ctxt, Object builder)BooleansupportsUpdate(DeserializationConfig config)Introspection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not.JsonDeserializer<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.BeanDeserializerBasewithBeanProperties(BeanPropertyMap props)Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.BeanDeserializerBasewithIgnorableProperties(Set<String> ignorableProps)BeanDeserializerBasewithObjectIdReader(ObjectIdReader oir)-
Methods inherited from class com.fasterxml.jackson.databind.deser.BeanDeserializerBase
_convertObjectId, _findPropertyUnwrapper, _findSubclassDeserializer, _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, properties, replaceProperty, resolve, wrapAndThrow, wrapInstantiationProblem
-
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, handleMissingEndArrayForSingle, isDefaultDeserializer, isDefaultKeyDeserializer, parseDouble
-
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, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)
Constructor used byBeanDeserializerBuilder.
-
BuilderBasedDeserializer
@Deprecated public BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<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, Set<String> ignorableProps)
-
BuilderBasedDeserializer
public BuilderBasedDeserializer(BuilderBasedDeserializer src, BeanPropertyMap props)
-
-
Method Detail
-
unwrappingDeserializer
public JsonDeserializer<Object> unwrappingDeserializer(NameTransformer unwrapper)
Description copied from class:JsonDeserializerMethod 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:
unwrappingDeserializerin classBeanDeserializerBase
-
withObjectIdReader
public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)
- Specified by:
withObjectIdReaderin classBeanDeserializerBase
-
withIgnorableProperties
public BeanDeserializerBase withIgnorableProperties(Set<String> ignorableProps)
- Specified by:
withIgnorablePropertiesin classBeanDeserializerBase
-
withBeanProperties
public BeanDeserializerBase withBeanProperties(BeanPropertyMap props)
Description copied from class:BeanDeserializerBaseMutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.- Overrides:
withBeanPropertiesin classBeanDeserializerBase
-
asArrayDeserializer
protected BeanDeserializerBase asArrayDeserializer()
Description copied from class:BeanDeserializerBaseFluent 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:
asArrayDeserializerin classBeanDeserializerBase
-
supportsUpdate
public Boolean supportsUpdate(DeserializationConfig config)
Description copied from class:JsonDeserializerIntrospection method that may be called to see whether deserializer supports update of an existing value (aka "merging") or not. Return value should either beBoolean.FALSEif update is not supported at all (immutable values);Boolean.TRUEif update should usually work (regular POJOs, for example), ornullif 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.FALSEreturned, or inclusion ifBoolean.TRUEis specified. If "unknown" case (nullreturned) behavior is to exclude property if global defaults used; or to allow if explicit per-type or property merging is defined.Default implementation returns
nullto allow explicit per-type or per-property attempts.- Overrides:
supportsUpdatein classBeanDeserializerBase
-
finishBuild
protected Object finishBuild(DeserializationContext ctxt, Object builder) throws IOException
- Throws:
IOException
-
deserialize
public Object deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws IOException
Main deserialization method for bean-based objects (POJOs).- Specified by:
deserializein classJsonDeserializer<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:
IOException
-
deserialize
public Object deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object value) throws 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:
deserializein classJsonDeserializer<Object>- Throws:
IOException
-
deserializeFromObject
public Object deserializeFromObject(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws IOException
General version used when handling needs more advanced features.- Specified by:
deserializeFromObjectin classBeanDeserializerBase- Throws:
IOException
-
_deserializeUsingPropertyBased
protected Object _deserializeUsingPropertyBased(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws 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:
_deserializeUsingPropertyBasedin classBeanDeserializerBase- Returns:
- Builder instance constructed
- Throws:
IOException
-
_deserialize
protected final Object _deserialize(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object builder) throws IOException
- Throws:
IOException
-
deserializeWithView
protected final Object deserializeWithView(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView) throws IOException
- Throws:
IOException
-
deserializeWithUnwrapped
protected Object deserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws IOException
Method called when there are declared "unwrapped" properties which need special handling- Throws:
IOException
-
deserializeUsingPropertyBasedWithUnwrapped
protected Object deserializeUsingPropertyBasedWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws IOException
- Throws:
IOException
-
deserializeWithUnwrapped
protected Object deserializeWithUnwrapped(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object builder, TokenBuffer tokens) throws IOException
- Throws:
IOException
-
deserializeWithExternalTypeId
protected Object deserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws IOException
- Throws:
IOException
-
deserializeWithExternalTypeId
protected Object deserializeWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt, Object bean) throws IOException
- Throws:
IOException
-
deserializeUsingPropertyBasedWithExternalTypeId
protected Object deserializeUsingPropertyBasedWithExternalTypeId(com.fasterxml.jackson.core.JsonParser p, DeserializationContext ctxt) throws IOException
- Throws:
IOException
-
-