jackson-databind 2.16.0 · com.fasterxml.jackson.databind.introspect.POJOPropertiesCollector

Field Summary

Modifier and Type	Field and Description
protected final AccessorNamingStrategy	_accessorNaming Handler used for name-mangling of getter, mutator (setter/with) methods
protected final AnnotationIntrospector	_annotationIntrospector
protected LinkedList<AnnotatedMember>	_anyGetterField
protected LinkedList<AnnotatedMember>	_anyGetters
protected LinkedList<AnnotatedMember>	_anySetterField
protected LinkedList<AnnotatedMethod>	_anySetters
protected final AnnotatedClass	_classDef Low-level introspected class information (methods, fields etc)
protected boolean	_collected State flag we keep to indicate whether actual property information has been collected or not.
protected final MapperConfig<?>	_config Configuration settings
protected LinkedList<POJOPropertyBuilder>	_creatorProperties
protected Map<PropertyName, PropertyName>	_fieldRenameMappings A set of "field renamings" that have been discovered, indicating intended renaming of other accessors: key is the implicit original name and value intended name to use instead.
protected final boolean	_forSerialization True if introspection is done for serialization (giving precedence for serialization annotations), or not (false, deserialization)
protected HashSet<String>	_ignoredPropertyNames Lazily collected list of properties that can be implicitly ignored during serialization; only updated when collecting information for deserialization purposes
protected LinkedHashMap<Object, AnnotatedMember>	_injectables Lazily collected list of members that were annotated to indicate that they represent mutators for deserializer value injection.
protected final boolean	_isRecordType
protected LinkedList<AnnotatedMember>	_jsonKeyAccessors Accessors (field or "getter" method annotated with `com.fasterxml.jackson.annotation.JsonKey`
protected LinkedList<AnnotatedMember>	_jsonValueAccessors Accessors (field or "getter" method) annotated with `com.fasterxml.jackson.annotation.JsonValue`
protected String	_mutatorPrefix Deprecated Since 2.12
protected LinkedHashMap<String, POJOPropertyBuilder>	_properties Set of logical property information collected so far.
protected final boolean	_stdBeanNaming Deprecated Since 2.12
protected final JavaType	_type Type of POJO for which properties are being collected.
protected final boolean	_useAnnotations
protected final VisibilityChecker<?>	_visibilityChecker

Constructor Summary

Access	Constructor and Description
protected	POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, AccessorNamingStrategy accessorNaming)
protected	POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, String mutatorPrefix) Deprecated Since 2.12

Method Summary

Modifier and Type	Method and Description
private static AccessorNamingStrategy	_accessorNaming(MapperConfig<?> config, AnnotatedClass classDef, String mutatorPrefix)
protected void	_addCreatorParam(Map<String, POJOPropertyBuilder> props, AnnotatedParameter param)
private void	_addCreatorParam(Map<String, POJOPropertyBuilder> props, AnnotatedParameter param, String recordComponentName)
protected void	_addCreators(Map<String, POJOPropertyBuilder> props) Method for collecting basic information on constructor(s) found
protected void	_addFields(Map<String, POJOPropertyBuilder> props) Method for collecting basic information on all fields found
protected void	_addGetterMethod(Map<String, POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)
protected void	_addInjectables(Map<String, POJOPropertyBuilder> props)
protected void	_addMethods(Map<String, POJOPropertyBuilder> props) Method for collecting basic information on all fields found
protected void	_addSetterMethod(Map<String, POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)
private boolean	_anyIndexed(Collection<POJOPropertyBuilder> props)
private String	_checkRenameByField(String implName)
protected void	_collectIgnorals(String name) Helper method called to add explicitly ignored properties to a list of known ignored properties; this helps in proper reporting of errors.
protected void	_doAddInjectable(JacksonInject.Value injectable, AnnotatedMember m)
private PropertyNamingStrategy	_findNamingStrategy()
protected POJOPropertyBuilder	_property(Map<String, POJOPropertyBuilder> props, PropertyName name)
protected POJOPropertyBuilder	_property(Map<String, POJOPropertyBuilder> props, String implName)
private PropertyName	_propNameFromSimple(String simpleName)
protected void	_removeUnwantedAccessor(Map<String, POJOPropertyBuilder> props) Method called to further get rid of unwanted individual accessors, based on read/write settings and rules for "pulling in" accessors (or not).
protected void	_removeUnwantedProperties(Map<String, POJOPropertyBuilder> props) Method called to get rid of candidate properties that are marked as ignored.
protected void	_renameProperties(Map<String, POJOPropertyBuilder> props)
protected void	_renameUsing(Map<String, POJOPropertyBuilder> propMap, PropertyNamingStrategy naming)
protected void	_renameWithWrappers(Map<String, POJOPropertyBuilder> props)
protected boolean	_replaceCreatorProperty(POJOPropertyBuilder prop, List<POJOPropertyBuilder> creatorProperties)
protected boolean	Returns: True if seeming conflict was resolved and there only remains single accessor _resolveFieldVsGetter(List<AnnotatedMember> accessors) Method that will be given a `List` with 2 or more accessors that may be in conflict: it will need to remove lower-priority accessors to leave just a single highest-priority accessor to use.
protected void	_sortProperties(Map<String, POJOPropertyBuilder> props)
protected void	_updateCreatorProperty(POJOPropertyBuilder prop, List<POJOPropertyBuilder> creatorProperties) Deprecated
protected void	collectAll() Internal method that will collect actual property information.
public Class<?>	findPOJOBuilderClass() Deprecated
public AnnotationIntrospector	getAnnotationIntrospector()
public AnnotatedMember	getAnyGetter() Deprecated Since 2.12 use separate `getAnyGetterMethod()` and `getAnyGetterField()`. Alias for `getAnyGetterMethod()`.
public AnnotatedMember	getAnyGetterField()
public AnnotatedMember	getAnyGetterMethod()
public AnnotatedMember	getAnySetterField()
public AnnotatedMethod	getAnySetterMethod()
public AnnotatedClass	getClassDef()
public MapperConfig<?>	getConfig()
public Set<String>	getIgnoredPropertyNames() Accessor for set of properties that are explicitly marked to be ignored via per-property markers (but NOT class annotations).
public Map<Object, AnnotatedMember>	getInjectables()
public AnnotatedMember	getJsonKeyAccessor()
public AnnotatedMember	getJsonValueAccessor()
public AnnotatedMethod	getJsonValueMethod() Deprecated
public ObjectIdInfo	getObjectIdInfo() Accessor to find out whether type specified requires inclusion of Object Identifier.
public List<BeanPropertyDefinition>	getProperties()
protected Map<String, POJOPropertyBuilder>	getPropertyMap()
public JavaType	getType()
public boolean	isRecordType()
protected void	reportProblem(String msg, Object... args)

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

Field Detail

_accessorNaming	back to summary
protected final AccessorNamingStrategy _accessorNaming Handler used for name-mangling of getter, mutator (setter/with) methods Since 2.12

_accessorNaming

back to summary

protected final AccessorNamingStrategy _accessorNaming

Handler used for name-mangling of getter, mutator (setter/with) methods

Since: 2.12

_annotationIntrospector	back to summary
protected final AnnotationIntrospector _annotationIntrospector

_anyGetterField	back to summary
protected LinkedList<AnnotatedMember> _anyGetterField Since 2.12

_anyGetters	back to summary
protected LinkedList<AnnotatedMember> _anyGetters

_anySetterField	back to summary
protected LinkedList<AnnotatedMember> _anySetterField

_anySetters	back to summary
protected LinkedList<AnnotatedMethod> _anySetters

_classDef	back to summary
protected final AnnotatedClass _classDef Low-level introspected class information (methods, fields etc)

_collected	back to summary
protected boolean _collected State flag we keep to indicate whether actual property information has been collected or not.

_config	back to summary
protected final MapperConfig<?> _config Configuration settings

_creatorProperties	back to summary
protected LinkedList<POJOPropertyBuilder> _creatorProperties

_fieldRenameMappings	back to summary
protected Map<PropertyName, PropertyName> _fieldRenameMappings A set of "field renamings" that have been discovered, indicating intended renaming of other accessors: key is the implicit original name and value intended name to use instead. Note that these renamings are applied earlier than "regular" (explicit) renamings and affect implicit name: their effect may be changed by further renaming based on explicit indicators. The main use case is to effectively relink accessors based on fields discovered, and used to sort of correct otherwise missing linkage between fields and other accessors. Since 2.11

_fieldRenameMappings

back to summary

protected Map<PropertyName, PropertyName> _fieldRenameMappings

A set of "field renamings" that have been discovered, indicating intended renaming of other accessors: key is the implicit original name and value intended name to use instead.

Note that these renamings are applied earlier than "regular" (explicit) renamings and affect implicit name: their effect may be changed by further renaming based on explicit indicators. The main use case is to effectively relink accessors based on fields discovered, and used to sort of correct otherwise missing linkage between fields and other accessors.

Since: 2.11

_forSerialization	back to summary
protected final boolean _forSerialization True if introspection is done for serialization (giving precedence for serialization annotations), or not (false, deserialization)

_ignoredPropertyNames	back to summary
protected HashSet<String> _ignoredPropertyNames Lazily collected list of properties that can be implicitly ignored during serialization; only updated when collecting information for deserialization purposes

_injectables	back to summary
protected LinkedHashMap<Object, AnnotatedMember> _injectables Lazily collected list of members that were annotated to indicate that they represent mutators for deserializer value injection.

_isRecordType	back to summary
protected final boolean _isRecordType Since 2.15

_jsonKeyAccessors back to summary

_jsonKeyAccessors	back to summary
protected LinkedList<AnnotatedMember> _jsonKeyAccessors Accessors (field or "getter" method annotated with `com.fasterxml.jackson.annotation.JsonKey` Since 2.12

protected LinkedList<AnnotatedMember> _jsonKeyAccessors

Accessors (field or "getter" method annotated with com.fasterxml.jackson.annotation.JsonKey

Since: 2.12

_jsonValueAccessors	back to summary
protected LinkedList<AnnotatedMember> _jsonValueAccessors Accessors (field or "getter" method) annotated with `com.fasterxml.jackson.annotation.JsonValue`

_mutatorPrefix	back to summary
protected String _mutatorPrefix Deprecated Since 2.12 Annotations @Deprecated

_properties	back to summary
protected LinkedHashMap<String, POJOPropertyBuilder> _properties Set of logical property information collected so far. Since 2.6, this has been constructed (more) lazily, to defer throwing of exceptions for potential conflicts in cases where this may not be an actual problem.

_properties

back to summary

protected LinkedHashMap<String, POJOPropertyBuilder> _properties

Set of logical property information collected so far.

Since 2.6, this has been constructed (more) lazily, to defer throwing of exceptions for potential conflicts in cases where this may not be an actual problem.

_stdBeanNaming	back to summary
protected final boolean _stdBeanNaming Deprecated Since 2.12 Annotations @Deprecated

_type	back to summary
protected final JavaType _type Type of POJO for which properties are being collected.

_useAnnotations	back to summary
protected final boolean _useAnnotations Since 2.9

_visibilityChecker	back to summary
protected final VisibilityChecker<?> _visibilityChecker

Constructor Detail

POJOPropertiesCollector	back to summary
protected POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, AccessorNamingStrategy accessorNaming) Since 2.12

POJOPropertiesCollector	back to summary
protected POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, String mutatorPrefix) Deprecated Since 2.12 Annotations @Deprecated

Method Detail

_accessorNaming	back to summary
private static AccessorNamingStrategy _accessorNaming(MapperConfig<?> config, AnnotatedClass classDef, String mutatorPrefix)

_addCreatorParam	back to summary
protected void _addCreatorParam(Map<String, POJOPropertyBuilder> props, AnnotatedParameter param) Since 2.4

_addCreatorParam	back to summary
private void _addCreatorParam(Map<String, POJOPropertyBuilder> props, AnnotatedParameter param, String recordComponentName)

_addCreators	back to summary
protected void _addCreators(Map<String, POJOPropertyBuilder> props) Method for collecting basic information on constructor(s) found

_addFields	back to summary
protected void _addFields(Map<String, POJOPropertyBuilder> props) Method for collecting basic information on all fields found

_addGetterMethod	back to summary
protected void _addGetterMethod(Map<String, POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)

_addInjectables	back to summary
protected void _addInjectables(Map<String, POJOPropertyBuilder> props)

_addMethods	back to summary
protected void _addMethods(Map<String, POJOPropertyBuilder> props) Method for collecting basic information on all fields found

_addSetterMethod	back to summary
protected void _addSetterMethod(Map<String, POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)

_anyIndexed	back to summary
private boolean _anyIndexed(Collection<POJOPropertyBuilder> props)

_checkRenameByField	back to summary
private String _checkRenameByField(String implName)

_collectIgnorals	back to summary
protected void _collectIgnorals(String name) Helper method called to add explicitly ignored properties to a list of known ignored properties; this helps in proper reporting of errors.

_doAddInjectable	back to summary
protected void _doAddInjectable(JacksonInject.Value injectable, AnnotatedMember m)

_findNamingStrategy	back to summary
private PropertyNamingStrategy _findNamingStrategy()

_property	back to summary
protected POJOPropertyBuilder _property(Map<String, POJOPropertyBuilder> props, PropertyName name)

_property	back to summary
protected POJOPropertyBuilder _property(Map<String, POJOPropertyBuilder> props, String implName)

_propNameFromSimple	back to summary
private PropertyName _propNameFromSimple(String simpleName)

_removeUnwantedAccessor	back to summary
protected void _removeUnwantedAccessor(Map<String, POJOPropertyBuilder> props) Method called to further get rid of unwanted individual accessors, based on read/write settings and rules for "pulling in" accessors (or not).

_removeUnwantedProperties	back to summary
protected void _removeUnwantedProperties(Map<String, POJOPropertyBuilder> props) Method called to get rid of candidate properties that are marked as ignored.

_renameProperties	back to summary
protected void _renameProperties(Map<String, POJOPropertyBuilder> props)

_renameUsing	back to summary
protected void _renameUsing(Map<String, POJOPropertyBuilder> propMap, PropertyNamingStrategy naming)

_renameWithWrappers	back to summary
protected void _renameWithWrappers(Map<String, POJOPropertyBuilder> props)

_replaceCreatorProperty	back to summary
protected boolean _replaceCreatorProperty(POJOPropertyBuilder prop, List<POJOPropertyBuilder> creatorProperties)

_resolveFieldVsGetter back to summary

protected boolean _resolveFieldVsGetter(List<AnnotatedMember> accessors)

Method that will be given a List with 2 or more accessors that may be in conflict: it will need to remove lower-priority accessors to leave just a single highest-priority accessor to use. If this succeeds method returns true, otherwise false.

Note

method will directly modify given List directly, regardless of whether it ultimately succeeds or not.

Returns:boolean: True if seeming conflict was resolved and there only remains single accessor

_sortProperties	back to summary
protected void _sortProperties(Map<String, POJOPropertyBuilder> props)

_updateCreatorProperty	back to summary
protected void _updateCreatorProperty(POJOPropertyBuilder prop, List<POJOPropertyBuilder> creatorProperties) Deprecated Annotations @Deprecated

collectAll

back to summary

protected void collectAll()

Internal method that will collect actual property information.

Since: 2.6

findPOJOBuilderClass	back to summary
public Class<?> findPOJOBuilderClass() Deprecated Annotations @Deprecated

getAnnotationIntrospector	back to summary
public AnnotationIntrospector getAnnotationIntrospector()

getAnyGetter back to summary

public AnnotatedMember getAnyGetter()

Deprecated

Since 2.12 use separate getAnyGetterMethod() and getAnyGetterField().

Alias for getAnyGetterMethod().

Annotations

@Deprecated

getAnyGetterField	back to summary
public AnnotatedMember getAnyGetterField() Since 2.12 (before only had "getAnyGetter()")

getAnyGetterMethod	back to summary
public AnnotatedMember getAnyGetterMethod() Since 2.12 (before only had "getAnyGetter()")

getAnySetterField	back to summary
public AnnotatedMember getAnySetterField()

getAnySetterMethod	back to summary
public AnnotatedMethod getAnySetterMethod()

getClassDef	back to summary
public AnnotatedClass getClassDef()

getConfig	back to summary
public MapperConfig<?> getConfig()

getIgnoredPropertyNames	back to summary
public Set<String> getIgnoredPropertyNames() Accessor for set of properties that are explicitly marked to be ignored via per-property markers (but NOT class annotations).

getInjectables	back to summary
public Map<Object, AnnotatedMember> getInjectables()

getJsonKeyAccessor	back to summary
public AnnotatedMember getJsonKeyAccessor() Since 2.12

getJsonValueAccessor	back to summary
public AnnotatedMember getJsonValueAccessor() Since 2.9

getJsonValueMethod	back to summary
public AnnotatedMethod getJsonValueMethod() Deprecated Annotations @Deprecated

getObjectIdInfo	back to summary
public ObjectIdInfo getObjectIdInfo() Accessor to find out whether type specified requires inclusion of Object Identifier.

getProperties	back to summary
public List<BeanPropertyDefinition> getProperties()

getPropertyMap	back to summary
protected Map<String, POJOPropertyBuilder> getPropertyMap()

getType	back to summary
public JavaType getType()

isRecordType	back to summary
public boolean isRecordType() Since 2.15

reportProblem	back to summary
protected void reportProblem(String msg, Object... args)

public Class POJOPropertiesCollector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail