com.fasterxml.jackson.databind.deser

## 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 and 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, _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 and Description
    --- | ---
    `` | `BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)` Deprecated. Since 2.9
    `` | `BuilderBasedDeserializer(BeanDeserializerBuilder builder, BeanDescription beanDesc, JavaType targetType, BeanPropertyMap properties, Map<String,SettableBeanProperty> backRefs, Set<String> ignorableProps, boolean ignoreAllUnknown, boolean hasViews)` Constructor used by `BeanDeserializerBuilder`.
    `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(BuilderBasedDeserializer src, BeanPropertyMap props)`
    `protected` | `BuilderBasedDeserializer(BuilderBasedDeserializer src, boolean ignoreAllUnknown)`
    `protected` | `BuilderBasedDeserializer(BuilderBasedDeserializer src, NameTransformer unwrapper)`
    `` | `BuilderBasedDeserializer(BuilderBasedDeserializer src, ObjectIdReader oir)`
    `` | `BuilderBasedDeserializer(BuilderBasedDeserializer src, Set<String> ignorableProps)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected Object` | `_deserialize(JsonParser p, DeserializationContext ctxt, Object builder)`
    `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 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 Object` | `deserializeWithView(JsonParser p, DeserializationContext ctxt, Object bean, Class<?> activeView)`
    `protected Object` | `finishBuild(DeserializationContext ctxt, Object builder)`
    `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<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` | `withIgnorableProperties(Set<String> ignorableProps)`
    `BeanDeserializerBase` | `withObjectIdReader(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`

    - ### Methods inherited from class java.lang.Object

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

- - ### 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 by `BeanDeserializerBuilder`.

    - #### 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: `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 class `BeanDeserializerBase`

    - #### withObjectIdReader

          public BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)

      Specified by:
        `withObjectIdReader` in class `BeanDeserializerBase`

    - #### withIgnorableProperties

          public BeanDeserializerBase withIgnorableProperties(Set<String> ignorableProps)

      Specified by:
        `withIgnorableProperties` 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: `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 `BeanDeserializerBase`

    - #### finishBuild

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

      Throws:
        `IOException`

    - #### deserialize

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

      Main deserialization method for bean-based objects (POJOs).
      Specified by:
        `deserialize` in class `JsonDeserializer<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:
        `IOException`

    - #### deserialize

          public Object deserialize(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:
        `deserialize` in class `JsonDeserializer<Object>`
      Throws:
        `IOException`

    - #### deserializeFromObject

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

      General version used when handling needs more advanced features.
      Specified by:
        `deserializeFromObject` in class `BeanDeserializerBase`
      Throws:
        `IOException`

    - #### _deserializeUsingPropertyBased

          protected Object _deserializeUsingPropertyBased(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:
        `_deserializeUsingPropertyBased` in class `BeanDeserializerBase`
      Returns:
        Builder instance constructed
      Throws:
        `IOException`

    - #### _deserialize

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

      Throws:
        `IOException`

    - #### deserializeWithView

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

      Throws:
        `IOException`

    - #### deserializeWithUnwrapped

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

      Method called when there are declared "unwrapped" properties which need special handling
      Throws:
        `IOException`

    - #### deserializeUsingPropertyBasedWithUnwrapped

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

      Throws:
        `IOException`

    - #### deserializeWithUnwrapped

          protected Object deserializeWithUnwrapped(JsonParser p,
                                                    DeserializationContext ctxt,
                                                    Object builder,
                                                    TokenBuffer tokens)
                                             throws IOException

      Throws:
        `IOException`

    - #### deserializeWithExternalTypeId

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

      Throws:
        `IOException`

    - #### deserializeWithExternalTypeId

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

      Throws:
        `IOException`

    - #### deserializeUsingPropertyBasedWithExternalTypeId

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

      Throws:
        `IOException`

Copyright © 2008–2019 FasterXML. All rights reserved.