BeanDeserializerBase (The Adobe AEM Quickstart and Web Application.)

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

All Implemented Interfaces:

ContextualDeserializer, NullValueProvider, ResolvableDeserializer, ValueInstantiator.Gettable, java.io.Serializable

Direct Known Subclasses:

BeanAsArrayBuilderDeserializer, BeanAsArrayDeserializer, BeanDeserializer, BuilderBasedDeserializer
```
public abstract class BeanDeserializerBase
extends StdDeserializer<java.lang.Object>
implements ContextualDeserializer, ResolvableDeserializer, ValueInstantiator.Gettable, java.io.Serializable
```
Base class for BeanDeserializer.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer
  JsonDeserializer.None

Constructor Summary

Constructors
Constructor and Description
`BeanDeserializerBase(BeanDeserializerBase src, ObjectIdReader oir)`
`BeanDeserializerBase(BeanDeserializerBase src, java.util.Set<java.lang.String> ignorableProps)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JsonDeserializer<?>`	`createContextual(DeserializationContext ctxt, BeanProperty property)` Although most of post-processing is done in resolve(), we only get access to referring property's annotations here; and this is needed to support per-property ObjectIds.
`java.util.Iterator<SettableBeanProperty>`	`creatorProperties()` Accessor for finding properties that represents values to pass through property-based creator method (constructor or factory method)
`java.lang.Object`	`deserializeFromArray(JsonParser p, DeserializationContext ctxt)`
`java.lang.Object`	`deserializeFromBoolean(JsonParser p, DeserializationContext ctxt)` Method called to deserialize POJO value from a JSON boolean value (true, false)
`java.lang.Object`	`deserializeFromDouble(JsonParser p, DeserializationContext ctxt)` Method called to deserialize POJO value from a JSON floating-point number.
`java.lang.Object`	`deserializeFromEmbedded(JsonParser p, DeserializationContext ctxt)`
`java.lang.Object`	`deserializeFromNumber(JsonParser p, DeserializationContext ctxt)`
`abstract java.lang.Object`	`deserializeFromObject(JsonParser p, DeserializationContext ctxt)` General version used when handling needs more advanced features.
`java.lang.Object`	`deserializeFromString(JsonParser p, DeserializationContext ctxt)`
`java.lang.Object`	`deserializeWithType(JsonParser p, DeserializationContext ctxt, TypeDeserializer typeDeserializer)` Base implementation that does not assume specific type inclusion mechanism.
`SettableBeanProperty`	`findBackReference(java.lang.String logicalName)` Method needed by `BeanDeserializerFactory` to properly link managed- and back-reference pairs.
`SettableBeanProperty`	`findProperty(int propertyIndex)` Alternate find method that tries to locate a property with given `property index`.
`SettableBeanProperty`	`findProperty(PropertyName propertyName)`
`SettableBeanProperty`	`findProperty(java.lang.String propertyName)` Accessor for finding the property with given name, if POJO has one.
`java.lang.Class<?>`	`getBeanClass()` Deprecated. Since 2.3, use `handledType()` instead
`AccessPattern`	`getEmptyAccessPattern()` This method may be called in conjunction with calls to `JsonDeserializer.getEmptyValue(DeserializationContext)`, to check whether it needs to be called just once (static values), or each time empty value is needed.
`java.lang.Object`	`getEmptyValue(DeserializationContext ctxt)` Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings).
`java.util.Collection<java.lang.Object>`	`getKnownPropertyNames()` Method that will either return null to indicate that type being deserializers has no concept of properties; or a collection of identifiers for which `toString` will give external property name.
`AccessPattern`	`getNullAccessPattern()` This method may be called in conjunction with calls to `JsonDeserializer.getNullValue(DeserializationContext)`, to check whether it needs to be called just once (static values), or each time empty value is needed.
`ObjectIdReader`	`getObjectIdReader()` Overridden to return true for those instances that are handling value for which Object Identity handling is enabled (either via value type or referring property).
`int`	`getPropertyCount()` Accessor for checking number of deserialized properties.
`ValueInstantiator`	`getValueInstantiator()`
`JavaType`	`getValueType()` Exact structured type this deserializer handles, if known.
`java.lang.Class<?>`	`handledType()` Method for accessing type of values this deserializer produces.
`boolean`	`hasProperty(java.lang.String propertyName)`
`boolean`	`hasViews()`
`boolean`	`isCachable()` Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).
`java.util.Iterator<SettableBeanProperty>`	`properties()` Accessor for iterating over properties this deserializer uses; with the exception that properties passed via Creator methods (specifically, "property-based constructor") are not included, but can be accessed separate by calling `creatorProperties()`
`void`	`replaceProperty(SettableBeanProperty original, SettableBeanProperty replacement)` Method that can be used to replace an existing property with a modified one.
`void`	`resolve(DeserializationContext ctxt)` Method called to finalize setup of this deserializer, after deserializer itself has been registered.
`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.
`abstract 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.
`abstract BeanDeserializerBase`	`withIgnorableProperties(java.util.Set<java.lang.String> ignorableProps)`
`abstract BeanDeserializerBase`	`withObjectIdReader(ObjectIdReader oir)`
`void`	`wrapAndThrow(java.lang.Throwable t, java.lang.Object bean, java.lang.String fieldName, DeserializationContext ctxt)` Method that will modify caught exception (passed in as argument) as necessary to include reference information, and to ensure it is a subtype of `IOException`, or an unchecked exception.

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer
getValueClass, getValueType

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer
deserialize, deserialize, deserializeWithType, getDelegatee, getEmptyValue, getNullValue, getNullValue, replaceDelegatee

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BeanDeserializerBase
```
public BeanDeserializerBase(BeanDeserializerBase src,
                            ObjectIdReader oir)
```
  - BeanDeserializerBase
```
public BeanDeserializerBase(BeanDeserializerBase src,
                            java.util.Set<java.lang.String> ignorableProps)
```
- Method Detail
  - unwrappingDeserializer
```
public abstract 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
    
    Overrides:
    
    unwrappingDeserializer in class JsonDeserializer<java.lang.Object>
  - withObjectIdReader
```
public abstract BeanDeserializerBase withObjectIdReader(ObjectIdReader oir)
```
  - withIgnorableProperties
```
public abstract BeanDeserializerBase withIgnorableProperties(java.util.Set<java.lang.String> ignorableProps)
```
  - withBeanProperties
```
public BeanDeserializerBase withBeanProperties(BeanPropertyMap props)
```
    Mutant factory method that custom sub-classes must override; not left as abstract to prevent more drastic backwards compatibility problems.
    
    Since:
    
    2.8
  - resolve
```
public void resolve(DeserializationContext ctxt)
             throws JsonMappingException
```
    Method called to finalize setup of this deserializer, after deserializer itself has been registered. This is needed to handle recursive and transitive dependencies.
    
    Specified by:
    
    resolve in interface ResolvableDeserializer
    
    Parameters:
    
    ctxt - Context to use for accessing configuration, resolving secondary deserializers
    
    Throws:
    
    JsonMappingException
  - createContextual
```
public JsonDeserializer<?> createContextual(DeserializationContext ctxt,
                                            BeanProperty property)
                                     throws JsonMappingException
```
    Although most of post-processing is done in resolve(), we only get access to referring property's annotations here; and this is needed to support per-property ObjectIds. We will also consider Shape transformations (read from Array) at this point, since it may come from either Class definition or property.
    
    Specified by:
    
    createContextual in interface ContextualDeserializer
    
    Parameters:
    
    ctxt - Deserialization context to access configuration, additional deserializers that may be needed by this deserializer
    
    property - Method, field or constructor parameter that represents the property (and is used to assign deserialized value). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' deserializer as is)
    
    Returns:
    
    Deserializer to use for deserializing values of specified property; may be this instance or a new instance.
    
    Throws:
    
    JsonMappingException
  - getNullAccessPattern
```
public AccessPattern getNullAccessPattern()
```
    Description copied from class: JsonDeserializer
    
    This method may be called in conjunction with calls to JsonDeserializer.getNullValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.
    Default implementation indicates that "null value" to use for input null is simply Java `null` for all deserializers, unless overridden by sub-classes. This information may be used as optimization.
    
    Specified by:
    
    getNullAccessPattern in interface NullValueProvider
    
    Overrides:
    
    getNullAccessPattern in class JsonDeserializer<java.lang.Object>
  - getEmptyAccessPattern
```
public AccessPattern getEmptyAccessPattern()
```
    Description copied from class: JsonDeserializer
    
    This method may be called in conjunction with calls to JsonDeserializer.getEmptyValue(DeserializationContext), to check whether it needs to be called just once (static values), or each time empty value is needed.
    
    Overrides:
    
    getEmptyAccessPattern in class JsonDeserializer<java.lang.Object>
  - getEmptyValue
```
public java.lang.Object getEmptyValue(DeserializationContext ctxt)
                               throws JsonMappingException
```
    Description copied from class: JsonDeserializer
    
    Method called to determine value to be used for "empty" values (most commonly when deserializing from empty JSON Strings). Usually this is same as JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) (which in turn is usually simply Java null), but it can be overridden for specific types. Or, if type should never be converted from empty String, method can also throw an exception.
    This method may be called once, or multiple times, depending on what JsonDeserializer.getEmptyAccessPattern() returns.
    Default implementation simply calls JsonDeserializer.getNullValue(com.fasterxml.jackson.databind.DeserializationContext) and returns value.
    
    Overrides:
    
    getEmptyValue in class JsonDeserializer<java.lang.Object>
    
    Throws:
    
    JsonMappingException
  - isCachable
```
public boolean isCachable()
```
    Description copied from class: JsonDeserializer
    
    Method called to see if deserializer instance is cachable and usable for other properties of same type (type for which instance was created).
    Note that cached instances are still resolved on per-property basis, if instance implements ResolvableDeserializer: cached instance is just as the base. This means that in most cases it is safe to cache instances; however, it only makes sense to cache instances if instantiation is expensive, or if instances are heavy-weight.
    Default implementation returns false, to indicate that no caching is done.
    
    Overrides:
    
    isCachable in class JsonDeserializer<java.lang.Object>
  - 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 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 JsonDeserializer<java.lang.Object>
  - handledType
```
public java.lang.Class<?> handledType()
```
    Description copied from class: JsonDeserializer
    
    Method for accessing type of values this deserializer produces. Note that this information is not guaranteed to be exact -- it may be a more generic (super-type) -- but it should not be incorrect (return a non-related type).
    Default implementation will return null, which means almost same same as returning Object.class would; that is, that nothing is known about handled type.
    
    Overrides:
    
    handledType in class StdDeserializer<java.lang.Object>
  - getObjectIdReader
```
public ObjectIdReader getObjectIdReader()
```
    Overridden to return true for those instances that are handling value for which Object Identity handling is enabled (either via value type or referring property).
    
    Overrides:
    
    getObjectIdReader in class JsonDeserializer<java.lang.Object>
    
    Returns:
    
    ObjectIdReader used for resolving possible Object Identifier value, instead of full value serialization, if deserializer can do that; null if no Object Id is expected.
  - hasProperty
```
public boolean hasProperty(java.lang.String propertyName)
```
  - hasViews
```
public boolean hasViews()
```
  - getPropertyCount
```
public int getPropertyCount()
```
    Accessor for checking number of deserialized properties.
  - getKnownPropertyNames
```
public java.util.Collection<java.lang.Object> getKnownPropertyNames()
```
    Description copied from class: JsonDeserializer
    
    Method that will either return null to indicate that type being deserializers has no concept of properties; or a collection of identifiers for which toString will give external property name. This is only to be used for error reporting and diagnostics purposes (most commonly, to accompany "unknown property" exception).
    
    Overrides:
    
    getKnownPropertyNames in class JsonDeserializer<java.lang.Object>
  - getBeanClass
```
@Deprecated
public final java.lang.Class<?> getBeanClass()
```
    Deprecated. Since 2.3, use handledType() instead
  - getValueType
```
public JavaType getValueType()
```
    Description copied from class: StdDeserializer
    
    Exact structured type this deserializer handles, if known.
    
    Overrides:
    
    getValueType in class StdDeserializer<java.lang.Object>
  - properties
```
public java.util.Iterator<SettableBeanProperty> properties()
```
    Accessor for iterating over properties this deserializer uses; with the exception that properties passed via Creator methods (specifically, "property-based constructor") are not included, but can be accessed separate by calling creatorProperties()
  - creatorProperties
```
public java.util.Iterator<SettableBeanProperty> creatorProperties()
```
    Accessor for finding properties that represents values to pass through property-based creator method (constructor or factory method)
    
    Since:
    
    2.0
  - findProperty
```
public SettableBeanProperty findProperty(PropertyName propertyName)
```
  - findProperty
```
public SettableBeanProperty findProperty(java.lang.String propertyName)
```
    Accessor for finding the property with given name, if POJO has one. Name used is the external name, i.e. name used in external data representation (JSON).
    
    Since:
    
    2.0
  - findProperty
```
public SettableBeanProperty findProperty(int propertyIndex)
```
    Alternate find method that tries to locate a property with given property index. Note that access by index is not necessarily faster than by name, since properties are not directly indexable; however, for most instances difference is not significant as number of properties is low.
    
    Since:
    
    2.3
  - findBackReference
```
public SettableBeanProperty findBackReference(java.lang.String logicalName)
```
    Method needed by BeanDeserializerFactory to properly link managed- and back-reference pairs.
    
    Overrides:
    
    findBackReference in class JsonDeserializer<java.lang.Object>
  - getValueInstantiator
```
public ValueInstantiator getValueInstantiator()
```
    Specified by:
    
    getValueInstantiator in interface ValueInstantiator.Gettable
  - replaceProperty
```
public void replaceProperty(SettableBeanProperty original,
                            SettableBeanProperty replacement)
```
    Method that can be used to replace an existing property with a modified one.
    NOTE: only ever use this method if you know what you are doing; incorrect usage can break deserializer.
    
    Parameters:
    
    original - Property to replace
    
    replacement - Property to replace it with
    
    Since:
    
    2.1
  - deserializeFromObject
```
public abstract java.lang.Object deserializeFromObject(JsonParser p,
                                                       DeserializationContext ctxt)
                                                throws java.io.IOException
```
    General version used when handling needs more advanced features.
    
    Throws:
    
    java.io.IOException
  - deserializeWithType
```
public java.lang.Object deserializeWithType(JsonParser p,
                                            DeserializationContext ctxt,
                                            TypeDeserializer typeDeserializer)
                                     throws java.io.IOException
```
    Description copied from class: StdDeserializer
    
    Base implementation that does not assume specific type inclusion mechanism. Sub-classes are expected to override this method if they are to handle type information.
    
    Overrides:
    
    deserializeWithType in class StdDeserializer<java.lang.Object>
    
    typeDeserializer - Deserializer to use for handling type information
    
    Throws:
    
    java.io.IOException
  - deserializeFromNumber
```
public java.lang.Object deserializeFromNumber(JsonParser p,
                                              DeserializationContext ctxt)
                                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - deserializeFromString
```
public java.lang.Object deserializeFromString(JsonParser p,
                                              DeserializationContext ctxt)
                                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - deserializeFromDouble
```
public java.lang.Object deserializeFromDouble(JsonParser p,
                                              DeserializationContext ctxt)
                                       throws java.io.IOException
```
    Method called to deserialize POJO value from a JSON floating-point number.
    
    Throws:
    
    java.io.IOException
  - deserializeFromBoolean
```
public java.lang.Object deserializeFromBoolean(JsonParser p,
                                               DeserializationContext ctxt)
                                        throws java.io.IOException
```
    Method called to deserialize POJO value from a JSON boolean value (true, false)
    
    Throws:
    
    java.io.IOException
  - deserializeFromArray
```
public java.lang.Object deserializeFromArray(JsonParser p,
                                             DeserializationContext ctxt)
                                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - deserializeFromEmbedded
```
public java.lang.Object deserializeFromEmbedded(JsonParser p,
                                                DeserializationContext ctxt)
                                         throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - wrapAndThrow
```
public void wrapAndThrow(java.lang.Throwable t,
                         java.lang.Object bean,
                         java.lang.String fieldName,
                         DeserializationContext ctxt)
                  throws java.io.IOException
```
    Method that will modify caught exception (passed in as argument) as necessary to include reference information, and to ensure it is a subtype of IOException, or an unchecked exception.
    Rules for wrapping and unwrapping are bit complicated; essentially:
    - Errors are to be passed as is (if uncovered via unwrapping)
    - "Plain" IOExceptions (ones that are not of type JsonMappingException are to be passed as is
    Throws:
    
    java.io.IOException

Class BeanDeserializerBase

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonDeserializer

Constructor Summary

Method Summary

Methods inherited from class com.fasterxml.jackson.databind.deser.std.StdDeserializer

Methods inherited from class com.fasterxml.jackson.databind.JsonDeserializer

Methods inherited from class java.lang.Object

Constructor Detail

BeanDeserializerBase

BeanDeserializerBase

Method Detail

unwrappingDeserializer

withObjectIdReader

withIgnorableProperties

withBeanProperties

resolve

createContextual

getNullAccessPattern

getEmptyAccessPattern

getEmptyValue

isCachable

supportsUpdate

handledType

getObjectIdReader

hasProperty

hasViews

getPropertyCount

getKnownPropertyNames

getBeanClass

getValueType

properties

creatorProperties

findProperty

findProperty

findProperty

findBackReference

getValueInstantiator

replaceProperty

deserializeFromObject

deserializeWithType

deserializeFromNumber

deserializeFromString

deserializeFromDouble

deserializeFromBoolean

deserializeFromArray

deserializeFromEmbedded

wrapAndThrow