jackson-databind 2.16.0 · com.fasterxml.jackson.databind.deser.BeanDeserializerBuilder

Field Summary

Modifier and Type	Field and Description
protected SettableAnyProperty	_anySetter Fallback setter used for handling any properties that are not mapped to regular setters.
protected HashMap<String, SettableBeanProperty>	_backRefProperties Back-reference properties this bean contains (if any)
protected final BeanDescription	_beanDesc Introspected information about POJO for deserializer to handle
protected JsonPOJOBuilder.Value	_builderConfig In addition, Builder may have additional configuration
protected AnnotatedMethod	_buildMethod When creating Builder-based deserializers, this indicates method to call on builder to finalize value.
protected final DeserializationConfig	_config
protected final DeserializationContext	_context
protected HashSet<String>	_ignorableProps Set of names of properties that are recognized but are to be ignored for deserialization purposes (meaning no exception is thrown, value is just skipped).
protected boolean	_ignoreAllUnknown Flag that can be set to ignore and skip unknown properties.
protected HashSet<String>	_includableProps Set of names of properties that are recognized and are set to be included for deserialization purposes (null deactivate this, empty includes nothing).
protected List<ValueInjector>	_injectables Value injectors for deserialization
protected ObjectIdReader	_objectIdReader Handler for Object Id values, if Object Ids are enabled for the bean type.
protected final Map<String, SettableBeanProperty>	_properties Properties to deserialize collected so far.
protected ValueInstantiator	_valueInstantiator Object that will handle value instantiation for the bean type.

Constructor Summary

Access	Constructor and Description
public	BeanDeserializerBuilder(BeanDescription beanDesc, DeserializationContext ctxt)
protected	BeanDeserializerBuilder(BeanDeserializerBuilder src) Copy constructor for sub-classes to use, when constructing custom builder instances

Method Summary

Modifier and Type	Method and Description
protected Map<String, List<PropertyName>>	_collectAliases(Collection<SettableBeanProperty> props)
private static HashMap<String, SettableBeanProperty>	_copy(HashMap<String, SettableBeanProperty> src)
private static <T> List<T>	_copy(List<T> src)
protected boolean	_findCaseInsensitivity()
protected void	_fixAccess(Collection<SettableBeanProperty> mainProps)
protected void	_handleBadAccess(IllegalArgumentException e0) Helper method for linking root cause to "invalid type definition" exception; needed for troubleshooting issues with forcing access on later JDKs (as module definition boundaries are more strictly enforced).
public void	addBackReferenceProperty(String referenceName, SettableBeanProperty prop) Method called to add a property that represents so-called back reference; reference that "points back" to object that has forward reference to currently built bean.
public void	addCreatorProperty(SettableBeanProperty prop) Method called by deserializer factory, when a "creator property" (something that is passed via constructor- or factory method argument; instead of setter or field).
public void	addIgnorable(String propName) Method that will add property name as one of properties that can be ignored if not recognized.
public void	addIncludable(String propName) Method that will add property name as one of the properties that will be included.
public void	addInjectable(PropertyName propName, JavaType propType, Annotations contextAnnotations, AnnotatedMember member, Object valueId)
public void	addOrReplaceProperty(SettableBeanProperty prop, boolean allowOverride) Method for adding a new property or replacing a property.
public void	addProperty(SettableBeanProperty prop) Method to add a property setter.
public JsonDeserializer<?>	build() Method for constructing a `BeanDeserializer`, given all information collected.
public AbstractDeserializer	buildAbstract() Alternate build method used when we must be using some form of abstract resolution, usually by using addition Type Id ("polymorphic deserialization")
public JsonDeserializer<?>	buildBuilderBased(JavaType valueType, String expBuildMethodName) Method for constructing a specialized deserializer that uses additional external Builder object during data binding.
protected JsonDeserializer<?>	createBuilderBasedDeserializer(JavaType valueType, BeanPropertyMap propertyMap, boolean anyViews) Extension point for overriding the actual creation of the builder deserializer.
public SettableBeanProperty	findProperty(PropertyName propertyName)
public SettableAnyProperty	getAnySetter()
public JsonPOJOBuilder.Value	getBuilderConfig()
public AnnotatedMethod	getBuildMethod()
public List<ValueInjector>	getInjectables()
public ObjectIdReader	getObjectIdReader()
public Iterator<SettableBeanProperty>	getProperties() Method that allows accessing all properties that this builder currently contains.
public ValueInstantiator	getValueInstantiator()
public boolean	hasIgnorable(String name)
public boolean	hasProperty(PropertyName propertyName)
public SettableBeanProperty	removeProperty(PropertyName name)
public void	setAnySetter(SettableAnyProperty s)
public void	setIgnoreUnknownProperties(boolean ignore)
public void	setObjectIdReader(ObjectIdReader r)
public void	setPOJOBuilder(AnnotatedMethod buildMethod, JsonPOJOBuilder.Value config)
public void	setValueInstantiator(ValueInstantiator inst)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_anySetter	back to summary
protected SettableAnyProperty _anySetter Fallback setter used for handling any properties that are not mapped to regular setters. If setter is not null, it will be called once for each such property.

_backRefProperties	back to summary
protected HashMap<String, SettableBeanProperty> _backRefProperties Back-reference properties this bean contains (if any)

_beanDesc	back to summary
protected final BeanDescription _beanDesc Introspected information about POJO for deserializer to handle

_builderConfig	back to summary
protected JsonPOJOBuilder.Value _builderConfig In addition, Builder may have additional configuration

_buildMethod	back to summary
protected AnnotatedMethod _buildMethod When creating Builder-based deserializers, this indicates method to call on builder to finalize value.

_config	back to summary
protected final DeserializationConfig _config

_context	back to summary
protected final DeserializationContext _context Since 2.9

_ignorableProps	back to summary
protected HashSet<String> _ignorableProps Set of names of properties that are recognized but are to be ignored for deserialization purposes (meaning no exception is thrown, value is just skipped).

_ignoreAllUnknown	back to summary
protected boolean _ignoreAllUnknown Flag that can be set to ignore and skip unknown properties. If set, will not throw an exception for unknown properties.

_includableProps	back to summary
protected HashSet<String> _includableProps Set of names of properties that are recognized and are set to be included for deserialization purposes (null deactivate this, empty includes nothing).

_injectables	back to summary
protected List<ValueInjector> _injectables Value injectors for deserialization

_objectIdReader	back to summary
protected ObjectIdReader _objectIdReader Handler for Object Id values, if Object Ids are enabled for the bean type.

_properties	back to summary
protected final Map<String, SettableBeanProperty> _properties Properties to deserialize collected so far.

_valueInstantiator	back to summary
protected ValueInstantiator _valueInstantiator Object that will handle value instantiation for the bean type.

Constructor Detail

BeanDeserializerBuilder	back to summary
public BeanDeserializerBuilder(BeanDescription beanDesc, DeserializationContext ctxt)

BeanDeserializerBuilder	back to summary
protected BeanDeserializerBuilder(BeanDeserializerBuilder src) Copy constructor for sub-classes to use, when constructing custom builder instances

Method Detail

_collectAliases	back to summary
protected Map<String, List<PropertyName>> _collectAliases(Collection<SettableBeanProperty> props)

_copy	back to summary
private static HashMap<String, SettableBeanProperty> _copy(HashMap<String, SettableBeanProperty> src)

_copy	back to summary
private static <T> List<T> _copy(List<T> src)

_findCaseInsensitivity	back to summary
protected boolean _findCaseInsensitivity()

_fixAccess	back to summary
protected void _fixAccess(Collection<SettableBeanProperty> mainProps) throws JsonMappingException

_handleBadAccess	back to summary
protected void _handleBadAccess(IllegalArgumentException e0) throws JsonMappingException Helper method for linking root cause to "invalid type definition" exception; needed for troubleshooting issues with forcing access on later JDKs (as module definition boundaries are more strictly enforced). Since 2.13.2

_handleBadAccess

back to summary

protected void _handleBadAccess(IllegalArgumentException e0) throws JsonMappingException

Helper method for linking root cause to "invalid type definition" exception; needed for troubleshooting issues with forcing access on later JDKs (as module definition boundaries are more strictly enforced).

Since: 2.13.2

addBackReferenceProperty	back to summary
public void addBackReferenceProperty(String referenceName, SettableBeanProperty prop) throws JsonMappingException Method called to add a property that represents so-called back reference; reference that "points back" to object that has forward reference to currently built bean.

addCreatorProperty	back to summary
public void addCreatorProperty(SettableBeanProperty prop) Method called by deserializer factory, when a "creator property" (something that is passed via constructor- or factory method argument; instead of setter or field). Default implementation does not do anything; we may need to revisit this decision if these properties need to be available through accessors. For now, however, we just have to ensure that we don't try to resolve types that masked setter/field has (see [JACKSON-700] for details).

addCreatorProperty

back to summary

public void addCreatorProperty(SettableBeanProperty prop)

Method called by deserializer factory, when a "creator property" (something that is passed via constructor- or factory method argument; instead of setter or field).

Default implementation does not do anything; we may need to revisit this decision if these properties need to be available through accessors. For now, however, we just have to ensure that we don't try to resolve types that masked setter/field has (see [JACKSON-700] for details).

addIgnorable	back to summary
public void addIgnorable(String propName) Method that will add property name as one of properties that can be ignored if not recognized.

addIncludable	back to summary
public void addIncludable(String propName) Method that will add property name as one of the properties that will be included. Since 2.12

addIncludable

back to summary

public void addIncludable(String propName)

Method that will add property name as one of the properties that will be included.

Since: 2.12

addInjectable	back to summary
public void addInjectable(PropertyName propName, JavaType propType, Annotations contextAnnotations, AnnotatedMember member, Object valueId) throws JsonMappingException

addOrReplaceProperty	back to summary
public void addOrReplaceProperty(SettableBeanProperty prop, boolean allowOverride) Method for adding a new property or replacing a property.

addProperty	back to summary
public void addProperty(SettableBeanProperty prop) Method to add a property setter. Will ensure that there is no unexpected override; if one is found will throw a `IllegalArgumentException`.

build	back to summary
public JsonDeserializer<?> build() throws JsonMappingException Method for constructing a `BeanDeserializer`, given all information collected.

buildAbstract	back to summary
public AbstractDeserializer buildAbstract() Alternate build method used when we must be using some form of abstract resolution, usually by using addition Type Id ("polymorphic deserialization") Since 2.0

buildAbstract

back to summary

public AbstractDeserializer buildAbstract()

Alternate build method used when we must be using some form of abstract resolution, usually by using addition Type Id ("polymorphic deserialization")

Since: 2.0

buildBuilderBased	back to summary
public JsonDeserializer<?> buildBuilderBased(JavaType valueType, String expBuildMethodName) throws JsonMappingException Method for constructing a specialized deserializer that uses additional external Builder object during data binding.

createBuilderBasedDeserializer	back to summary
protected JsonDeserializer<?> createBuilderBasedDeserializer(JavaType valueType, BeanPropertyMap propertyMap, boolean anyViews) Extension point for overriding the actual creation of the builder deserializer. Since 2.11

createBuilderBasedDeserializer

back to summary

protected JsonDeserializer<?> createBuilderBasedDeserializer(JavaType valueType, BeanPropertyMap propertyMap, boolean anyViews)

Extension point for overriding the actual creation of the builder deserializer.

Since: 2.11

findProperty	back to summary
public SettableBeanProperty findProperty(PropertyName propertyName)

getAnySetter	back to summary
public SettableAnyProperty getAnySetter()

getBuilderConfig	back to summary
public JsonPOJOBuilder.Value getBuilderConfig()

getBuildMethod	back to summary
public AnnotatedMethod getBuildMethod()

getInjectables	back to summary
public List<ValueInjector> getInjectables()

getObjectIdReader	back to summary
public ObjectIdReader getObjectIdReader()

getProperties	back to summary
public Iterator<SettableBeanProperty> getProperties() Method that allows accessing all properties that this builder currently contains. Note that properties are returned in order that properties are ordered (explictly, or by rule), which is the serialization order.

getProperties

back to summary

public Iterator<SettableBeanProperty> getProperties()

Method that allows accessing all properties that this builder currently contains.

Note that properties are returned in order that properties are ordered (explictly, or by rule), which is the serialization order.

getValueInstantiator	back to summary
public ValueInstantiator getValueInstantiator()

hasIgnorable	back to summary
public boolean hasIgnorable(String name) Since 2.9.4

hasProperty	back to summary
public boolean hasProperty(PropertyName propertyName)

removeProperty	back to summary
public SettableBeanProperty removeProperty(PropertyName name)

setAnySetter	back to summary
public void setAnySetter(SettableAnyProperty s)

setIgnoreUnknownProperties	back to summary
public void setIgnoreUnknownProperties(boolean ignore)

setObjectIdReader	back to summary
public void setObjectIdReader(ObjectIdReader r)

setPOJOBuilder	back to summary
public void setPOJOBuilder(AnnotatedMethod buildMethod, JsonPOJOBuilder.Value config)

setValueInstantiator	back to summary
public void setValueInstantiator(ValueInstantiator inst)

public Class BeanDeserializerBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail