com.fasterxml.jackson.databind.deser

## Class BeanDeserializerFactory

- java.lang.Object
- - com.fasterxml.jackson.databind.deser.DeserializerFactory
  - - com.fasterxml.jackson.databind.deser.BasicDeserializerFactory
    - - com.fasterxml.jackson.databind.deser.BeanDeserializerFactory

- All Implemented Interfaces:
    Serializable

      public class BeanDeserializerFactory
      extends BasicDeserializerFactory
      implements Serializable

  Concrete deserializer factory class that adds full Bean deserializer construction logic using class introspection. Note that factories specifically do not implement any form of caching: aside from configuration they are stateless; caching is implemented by other components.

  Instances of this class are fully immutable as all configuration is done by using "fluent factories" (methods that construct new factory instances with different configuration, instead of modifying instance).

  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static BeanDeserializerFactory` | `instance` Globally shareable thread-safe instance which has no additional custom deserializers registered

    - ### Fields inherited from class com.fasterxml.jackson.databind.deser.BasicDeserializerFactory

      `_factoryConfig, UNWRAPPED_CREATOR_PARAM_NAME`

    - ### Fields inherited from class com.fasterxml.jackson.databind.deser.DeserializerFactory

      `NO_DESERIALIZERS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `BeanDeserializerFactory(DeserializerFactoryConfig config)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `addBeanProps(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder)` Method called to figure out settable properties for the bean deserializer to use.
    `protected void` | `addInjectables(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder)` Method called locate all members used for value injection (if any), constructor `ValueInjector` instances, and add them to builder.
    `protected void` | `addObjectIdReader(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder)`
    `protected void` | `addReferenceProperties(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder)` Method that will find if bean has any managed- or back-reference properties, and if so add them to bean, to be linked during resolution phase.
    `JsonDeserializer<Object>` | `buildBeanDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription beanDesc)` Method that is to actually build a bean deserializer instance.
    `protected JsonDeserializer<Object>` | `buildBuilderBasedDeserializer(DeserializationContext ctxt, JavaType valueType, BeanDescription builderDesc)` Method for constructing a bean deserializer that uses specified intermediate Builder for binding data, and construction of the value instance.
    `JsonDeserializer<Object>` | `buildThrowableDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription beanDesc)`
    `protected SettableAnyProperty` | `constructAnySetter(DeserializationContext ctxt, BeanDescription beanDesc, AnnotatedMethod setter)` Method called to construct fallback `SettableAnyProperty` for handling unknown bean properties, given a method that has been designated as such setter.
    `protected BeanDeserializerBuilder` | `constructBeanDeserializerBuilder(DeserializationContext ctxt, BeanDescription beanDesc)` Overridable method that constructs a `BeanDeserializerBuilder` which is used to accumulate information needed to create deserializer instance.
    `protected SettableBeanProperty` | `constructSettableProperty(DeserializationContext ctxt, BeanDescription beanDesc, BeanPropertyDefinition propDef, JavaType propType0)` Method that will construct a regular bean property setter using the given setter method.
    `protected SettableBeanProperty` | `constructSetterlessProperty(DeserializationContext ctxt, BeanDescription beanDesc, BeanPropertyDefinition propDef)` Method that will construct a regular bean property setter using the given setter method.
    `JsonDeserializer<Object>` | `createBeanDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription beanDesc)` Method that `DeserializerCache`s call to create a new deserializer for types other than Collections, Maps, arrays and enums.
    `JsonDeserializer<Object>` | `createBuilderBasedDeserializer(DeserializationContext ctxt, JavaType valueType, BeanDescription beanDesc, Class<?> builderClass)` Method called to create a deserializer that will use specified Builder class for building value instances.
    `protected List<BeanPropertyDefinition>` | `filterBeanProps(DeserializationContext ctxt, BeanDescription beanDesc, BeanDeserializerBuilder builder, List<BeanPropertyDefinition> propDefsIn, Set<String> ignored)` Helper method called to filter out explicit ignored properties, as well as properties that have "ignorable types".
    `protected JsonDeserializer<?>` | `findStdDeserializer(DeserializationContext ctxt, JavaType type, BeanDescription beanDesc)` Method called by `BeanDeserializerFactory` to see if there might be a standard deserializer registered for given type.
    `protected boolean` | `isIgnorableType(DeserializationConfig config, BeanDescription beanDesc, Class<?> type, Map<Class<?>,Boolean> ignoredTypes)` Helper method that will check whether given raw type is marked as always ignorable (for purpose of ignoring properties with type)
    `protected boolean` | `isPotentialBeanType(Class<?> type)` Helper method used to skip processing for types that we know can not be (i.e.
    `protected JavaType` | `materializeAbstractType(DeserializationContext ctxt, JavaType type, BeanDescription beanDesc)`
    `DeserializerFactory` | `withConfig(DeserializerFactoryConfig config)` Method used by module registration functionality, to construct a new bean deserializer factory with different configuration settings.

    - ### Methods inherited from class com.fasterxml.jackson.databind.deser.BasicDeserializerFactory

      `_addDeserializerConstructors, _addDeserializerFactoryMethods, _checkIfCreatorPropertyBased, _checkImplicitlyNamedConstructors, _constructDefaultValueInstantiator, _findCreatorsFromProperties, _findCustomArrayDeserializer, _findCustomBeanDeserializer, _findCustomCollectionDeserializer, _findCustomCollectionLikeDeserializer, _findCustomEnumDeserializer, _findCustomMapDeserializer, _findCustomMapLikeDeserializer, _findCustomReferenceDeserializer, _findCustomTreeNodeDeserializer, _findExplicitParamName, _findImplicitParamName, _findJsonValueFor, _findParamName, _findRemappedType, _handleSingleArgumentConstructor, _handleSingleArgumentFactory, _hasExplicitParamName, _mapAbstractCollectionType, _valueInstantiatorInstance, constructCreatorProperty, constructEnumResolver, createArrayDeserializer, createCollectionDeserializer, createCollectionLikeDeserializer, createEnumDeserializer, createKeyDeserializer, createMapDeserializer, createMapLikeDeserializer, createReferenceDeserializer, createTreeDeserializer, findDefaultDeserializer, findDeserializerFromAnnotation, findKeyDeserializerFromAnnotation, findOptionalStdDeserializer, findPropertyContentTypeDeserializer, findPropertyTypeDeserializer, findTypeDeserializer, findValueInstantiator, getFactoryConfig, mapAbstractType, modifyTypeByAnnotation, resolveType, withAbstractTypeResolver, withAdditionalDeserializers, withAdditionalKeyDeserializers, withDeserializerModifier, withValueInstantiators`

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

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

- - ### Field Detail

    - #### instance

          public static final BeanDeserializerFactory instance

      Globally shareable thread-safe instance which has no additional custom deserializers registered

  - ### Constructor Detail

    - #### BeanDeserializerFactory

          public BeanDeserializerFactory(DeserializerFactoryConfig config)

  - ### Method Detail

    - #### withConfig

          public DeserializerFactory withConfig(DeserializerFactoryConfig config)

      Method used by module registration functionality, to construct a new bean deserializer factory with different configuration settings.
      Specified by:
        `withConfig` in class `BasicDeserializerFactory`

    - #### createBeanDeserializer

          public JsonDeserializer<Object> createBeanDeserializer(DeserializationContext ctxt,
                                                        JavaType type,
                                                        BeanDescription beanDesc)
                                                          throws JsonMappingException

      Method that `DeserializerCache`s call to create a new deserializer for types other than Collections, Maps, arrays and enums.
      Specified by:
        `createBeanDeserializer` in class `DeserializerFactory`
        `type` - Type to be deserialized
      Throws:
        `JsonMappingException`

    - #### createBuilderBasedDeserializer

          public JsonDeserializer<Object> createBuilderBasedDeserializer(DeserializationContext ctxt,
                                                                JavaType valueType,
                                                                BeanDescription beanDesc,
                                                                Class<?> builderClass)
                                                                  throws JsonMappingException

      Description copied from class: `DeserializerFactory`
      Method called to create a deserializer that will use specified Builder class for building value instances.
      Specified by:
        `createBuilderBasedDeserializer` in class `DeserializerFactory`
      Throws:
        `JsonMappingException`

    - #### findStdDeserializer

          protected JsonDeserializer<?> findStdDeserializer(DeserializationContext ctxt,
                                                JavaType type,
                                                BeanDescription beanDesc)
                                                     throws JsonMappingException

      Method called by `BeanDeserializerFactory` to see if there might be a standard deserializer registered for given type.
      Throws:
        `JsonMappingException`

    - #### materializeAbstractType

          protected JavaType materializeAbstractType(DeserializationContext ctxt,
                                         JavaType type,
                                         BeanDescription beanDesc)
                                              throws JsonMappingException

      Throws:
        `JsonMappingException`

    - #### buildBeanDeserializer

          public JsonDeserializer<Object> buildBeanDeserializer(DeserializationContext ctxt,
                                                       JavaType type,
                                                       BeanDescription beanDesc)
                                                         throws JsonMappingException

      Method that is to actually build a bean deserializer instance. All basic sanity checks have been done to know that what we have may be a valid bean type, and that there are no default simple deserializers.
      Throws:
        `JsonMappingException`

    - #### buildBuilderBasedDeserializer

          protected JsonDeserializer<Object> buildBuilderBasedDeserializer(DeserializationContext ctxt,
                                                               JavaType valueType,
                                                               BeanDescription builderDesc)
                                                                    throws JsonMappingException

      Method for constructing a bean deserializer that uses specified intermediate Builder for binding data, and construction of the value instance. Note that implementation is mostly copied from the regular BeanDeserializer build method.
      Throws:
        `JsonMappingException`

    - #### addObjectIdReader

          protected void addObjectIdReader(DeserializationContext ctxt,
                               BeanDescription beanDesc,
                               BeanDeserializerBuilder builder)
                                    throws JsonMappingException

      Throws:
        `JsonMappingException`

    - #### buildThrowableDeserializer

          public JsonDeserializer<Object> buildThrowableDeserializer(DeserializationContext ctxt,
                                                            JavaType type,
                                                            BeanDescription beanDesc)
                                                              throws JsonMappingException

      Throws:
        `JsonMappingException`

    - #### constructBeanDeserializerBuilder

          protected BeanDeserializerBuilder constructBeanDeserializerBuilder(DeserializationContext ctxt,
                                                                 BeanDescription beanDesc)

      Overridable method that constructs a `BeanDeserializerBuilder` which is used to accumulate information needed to create deserializer instance.

    - #### addBeanProps

          protected void addBeanProps(DeserializationContext ctxt,
                          BeanDescription beanDesc,
                          BeanDeserializerBuilder builder)
                               throws JsonMappingException

      Method called to figure out settable properties for the bean deserializer to use.

      Note: designed to be overridable, and effort is made to keep interface similar between versions.

      Throws:
        `JsonMappingException`

    - #### filterBeanProps

          protected List<BeanPropertyDefinition> filterBeanProps(DeserializationContext ctxt,
                                                     BeanDescription beanDesc,
                                                     BeanDeserializerBuilder builder,
                                                     List<BeanPropertyDefinition> propDefsIn,
                                                     Set<String> ignored)
                                                          throws JsonMappingException

      Helper method called to filter out explicit ignored properties, as well as properties that have "ignorable types". Note that this will not remove properties that have no setters.
      Throws:
        `JsonMappingException`

    - #### addReferenceProperties

          protected void addReferenceProperties(DeserializationContext ctxt,
                                    BeanDescription beanDesc,
                                    BeanDeserializerBuilder builder)
                                         throws JsonMappingException

      Method that will find if bean has any managed- or back-reference properties, and if so add them to bean, to be linked during resolution phase.
      Throws:
        `JsonMappingException`

    - #### addInjectables

          protected void addInjectables(DeserializationContext ctxt,
                            BeanDescription beanDesc,
                            BeanDeserializerBuilder builder)
                                 throws JsonMappingException

      Method called locate all members used for value injection (if any), constructor `ValueInjector` instances, and add them to builder.
      Throws:
        `JsonMappingException`

    - #### constructAnySetter

          protected SettableAnyProperty constructAnySetter(DeserializationContext ctxt,
                                               BeanDescription beanDesc,
                                               AnnotatedMethod setter)
                                                    throws JsonMappingException

      Method called to construct fallback `SettableAnyProperty` for handling unknown bean properties, given a method that has been designated as such setter.
      Throws:
        `JsonMappingException`

    - #### constructSettableProperty

          protected SettableBeanProperty constructSettableProperty(DeserializationContext ctxt,
                                                       BeanDescription beanDesc,
                                                       BeanPropertyDefinition propDef,
                                                       JavaType propType0)
                                                            throws JsonMappingException

      Method that will construct a regular bean property setter using the given setter method.
      Returns:
        Property constructed, if any; or null to indicate that there should be no property based on given definitions.
      Throws:
        `JsonMappingException`

    - #### constructSetterlessProperty

          protected SettableBeanProperty constructSetterlessProperty(DeserializationContext ctxt,
                                                         BeanDescription beanDesc,
                                                         BeanPropertyDefinition propDef)
                                                              throws JsonMappingException

      Method that will construct a regular bean property setter using the given setter method.
      Throws:
        `JsonMappingException`

    - #### isPotentialBeanType

          protected boolean isPotentialBeanType(Class<?> type)

      Helper method used to skip processing for types that we know can not be (i.e. are never consider to be) beans: things like primitives, Arrays, Enums, and proxy types.

      Note that usually we shouldn't really be getting these sort of types anyway; but better safe than sorry.

    - #### isIgnorableType

          protected boolean isIgnorableType(DeserializationConfig config,
                                BeanDescription beanDesc,
                                Class<?> type,
                                Map<Class<?>,Boolean> ignoredTypes)

      Helper method that will check whether given raw type is marked as always ignorable (for purpose of ignoring properties with type)

Copyright © 2008–2016 FasterXML. All rights reserved.