Class POJOPropertiesCollector
- java.lang.Object
-
- com.fasterxml.jackson.databind.introspect.POJOPropertiesCollector
-
public class POJOPropertiesCollector extends java.lang.Object
Helper class used for aggregating information about all possible properties of a POJO.
-
-
Field Summary
Fields Modifier and Type Field Description protected AccessorNamingStrategy
_accessorNaming
Handler used for name-mangling of getter, mutator (setter/with) methodsprotected AnnotationIntrospector
_annotationIntrospector
protected java.util.LinkedList<AnnotatedMember>
_anyGetterField
protected java.util.LinkedList<AnnotatedMember>
_anyGetters
protected java.util.LinkedList<AnnotatedMember>
_anySetterField
protected java.util.LinkedList<AnnotatedMethod>
_anySetters
protected 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 MapperConfig<?>
_config
Configuration settingsprotected java.util.LinkedList<POJOPropertyBuilder>
_creatorProperties
protected java.util.Map<PropertyName,PropertyName>
_fieldRenameMappings
A set of "field renamings" that have been discovered, indicating intended renaming of other accesors: key is the implicit original name and value intended name to use instead.protected boolean
_forSerialization
True if introspection is done for serialization (giving precedence for serialization annotations), or not (false, deserialization)protected java.util.HashSet<java.lang.String>
_ignoredPropertyNames
Lazily collected list of properties that can be implicitly ignored during serialization; only updated when collecting information for deserialization purposesprotected java.util.LinkedHashMap<java.lang.Object,AnnotatedMember>
_injectables
Lazily collected list of members that were annotated to indicate that they represent mutators for deserializer value injection.protected java.util.LinkedList<AnnotatedMember>
_jsonKeyAccessors
Accessors (field or "getter" method annotated withJsonKey
protected java.util.LinkedList<AnnotatedMember>
_jsonValueAccessors
Accessors (field or "getter" method) annotated withJsonValue
protected java.lang.String
_mutatorPrefix
Deprecated.Since 2.12protected java.util.LinkedHashMap<java.lang.String,POJOPropertyBuilder>
_properties
Set of logical property information collected so far.protected boolean
_stdBeanNaming
Deprecated.Since 2.12protected JavaType
_type
Type of POJO for which properties are being collected.protected boolean
_useAnnotations
protected VisibilityChecker<?>
_visibilityChecker
-
Constructor Summary
Constructors Modifier Constructor Description protected
POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, AccessorNamingStrategy accessorNaming)
protected
POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, java.lang.String mutatorPrefix)
Deprecated.Since 2.12
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
_addCreatorParam(java.util.Map<java.lang.String,POJOPropertyBuilder> props, AnnotatedParameter param)
protected void
_addCreators(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method for collecting basic information on constructor(s) foundprotected void
_addFields(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method for collecting basic information on all fields foundprotected void
_addGetterMethod(java.util.Map<java.lang.String,POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)
protected void
_addInjectables(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
protected void
_addMethods(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method for collecting basic information on all fields foundprotected void
_addSetterMethod(java.util.Map<java.lang.String,POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)
protected void
_collectIgnorals(java.lang.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(com.fasterxml.jackson.annotation.JacksonInject.Value injectable, AnnotatedMember m)
protected POJOPropertyBuilder
_property(java.util.Map<java.lang.String,POJOPropertyBuilder> props, PropertyName name)
protected POJOPropertyBuilder
_property(java.util.Map<java.lang.String,POJOPropertyBuilder> props, java.lang.String implName)
protected void
_removeUnwantedAccessor(java.util.Map<java.lang.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(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method called to get rid of candidate properties that are marked as ignored.protected void
_renameProperties(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
protected void
_renameUsing(java.util.Map<java.lang.String,POJOPropertyBuilder> propMap, PropertyNamingStrategy naming)
protected void
_renameWithWrappers(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
protected boolean
_replaceCreatorProperty(POJOPropertyBuilder prop, java.util.List<POJOPropertyBuilder> creatorProperties)
protected void
_sortProperties(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
protected void
_updateCreatorProperty(POJOPropertyBuilder prop, java.util.List<POJOPropertyBuilder> creatorProperties)
Deprecated.protected void
collectAll()
Internal method that will collect actual property information.java.lang.Class<?>
findPOJOBuilderClass()
Deprecated.AnnotationIntrospector
getAnnotationIntrospector()
AnnotatedMember
getAnyGetter()
Deprecated.Since 2.12 use separategetAnyGetterMethod()
andgetAnyGetterField()
.AnnotatedMember
getAnyGetterField()
AnnotatedMember
getAnyGetterMethod()
AnnotatedMember
getAnySetterField()
AnnotatedMethod
getAnySetterMethod()
AnnotatedClass
getClassDef()
MapperConfig<?>
getConfig()
java.util.Set<java.lang.String>
getIgnoredPropertyNames()
Accessor for set of properties that are explicitly marked to be ignored via per-property markers (but NOT class annotations).java.util.Map<java.lang.Object,AnnotatedMember>
getInjectables()
AnnotatedMember
getJsonKeyAccessor()
AnnotatedMember
getJsonValueAccessor()
AnnotatedMethod
getJsonValueMethod()
Deprecated.ObjectIdInfo
getObjectIdInfo()
Accessor to find out whether type specified requires inclusion of Object Identifier.java.util.List<BeanPropertyDefinition>
getProperties()
protected java.util.Map<java.lang.String,POJOPropertyBuilder>
getPropertyMap()
JavaType
getType()
protected void
reportProblem(java.lang.String msg, java.lang.Object... args)
-
-
-
Field Detail
-
_config
protected final MapperConfig<?> _config
Configuration settings
-
_accessorNaming
protected final AccessorNamingStrategy _accessorNaming
Handler used for name-mangling of getter, mutator (setter/with) methods- Since:
- 2.12
-
_forSerialization
protected final boolean _forSerialization
True if introspection is done for serialization (giving precedence for serialization annotations), or not (false, deserialization)
-
_type
protected final JavaType _type
Type of POJO for which properties are being collected.
-
_classDef
protected final AnnotatedClass _classDef
Low-level introspected class information (methods, fields etc)
-
_visibilityChecker
protected final VisibilityChecker<?> _visibilityChecker
-
_annotationIntrospector
protected final AnnotationIntrospector _annotationIntrospector
-
_useAnnotations
protected final boolean _useAnnotations
- Since:
- 2.9
-
_collected
protected boolean _collected
State flag we keep to indicate whether actual property information has been collected or not.
-
_properties
protected java.util.LinkedHashMap<java.lang.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.
-
_creatorProperties
protected java.util.LinkedList<POJOPropertyBuilder> _creatorProperties
-
_fieldRenameMappings
protected java.util.Map<PropertyName,PropertyName> _fieldRenameMappings
A set of "field renamings" that have been discovered, indicating intended renaming of other accesors: 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
-
_anyGetters
protected java.util.LinkedList<AnnotatedMember> _anyGetters
-
_anyGetterField
protected java.util.LinkedList<AnnotatedMember> _anyGetterField
- Since:
- 2.12
-
_anySetters
protected java.util.LinkedList<AnnotatedMethod> _anySetters
-
_anySetterField
protected java.util.LinkedList<AnnotatedMember> _anySetterField
-
_jsonKeyAccessors
protected java.util.LinkedList<AnnotatedMember> _jsonKeyAccessors
Accessors (field or "getter" method annotated withJsonKey
- Since:
- 2.12
-
_jsonValueAccessors
protected java.util.LinkedList<AnnotatedMember> _jsonValueAccessors
Accessors (field or "getter" method) annotated withJsonValue
-
_ignoredPropertyNames
protected java.util.HashSet<java.lang.String> _ignoredPropertyNames
Lazily collected list of properties that can be implicitly ignored during serialization; only updated when collecting information for deserialization purposes
-
_injectables
protected java.util.LinkedHashMap<java.lang.Object,AnnotatedMember> _injectables
Lazily collected list of members that were annotated to indicate that they represent mutators for deserializer value injection.
-
_stdBeanNaming
@Deprecated protected final boolean _stdBeanNaming
Deprecated.Since 2.12
-
_mutatorPrefix
@Deprecated protected java.lang.String _mutatorPrefix
Deprecated.Since 2.12
-
-
Constructor Detail
-
POJOPropertiesCollector
protected POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, AccessorNamingStrategy accessorNaming)
- Since:
- 2.12
-
POJOPropertiesCollector
@Deprecated protected POJOPropertiesCollector(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, java.lang.String mutatorPrefix)
Deprecated.Since 2.12
-
-
Method Detail
-
getConfig
public MapperConfig<?> getConfig()
-
getType
public JavaType getType()
-
getClassDef
public AnnotatedClass getClassDef()
-
getAnnotationIntrospector
public AnnotationIntrospector getAnnotationIntrospector()
-
getProperties
public java.util.List<BeanPropertyDefinition> getProperties()
-
getInjectables
public java.util.Map<java.lang.Object,AnnotatedMember> getInjectables()
-
getJsonKeyAccessor
public AnnotatedMember getJsonKeyAccessor()
- Since:
- 2.12
-
getJsonValueAccessor
public AnnotatedMember getJsonValueAccessor()
- Since:
- 2.9
-
getAnyGetter
@Deprecated public AnnotatedMember getAnyGetter()
Deprecated.Since 2.12 use separategetAnyGetterMethod()
andgetAnyGetterField()
.Alias forgetAnyGetterMethod()
.
-
getAnyGetterField
public AnnotatedMember getAnyGetterField()
- Since:
- 2.12 (before only had "getAnyGetter()")
-
getAnyGetterMethod
public AnnotatedMember getAnyGetterMethod()
- Since:
- 2.12 (before only had "getAnyGetter()")
-
getAnySetterField
public AnnotatedMember getAnySetterField()
-
getAnySetterMethod
public AnnotatedMethod getAnySetterMethod()
-
getIgnoredPropertyNames
public java.util.Set<java.lang.String> getIgnoredPropertyNames()
Accessor for set of properties that are explicitly marked to be ignored via per-property markers (but NOT class annotations).
-
getObjectIdInfo
public ObjectIdInfo getObjectIdInfo()
Accessor to find out whether type specified requires inclusion of Object Identifier.
-
getPropertyMap
protected java.util.Map<java.lang.String,POJOPropertyBuilder> getPropertyMap()
-
getJsonValueMethod
@Deprecated public AnnotatedMethod getJsonValueMethod()
Deprecated.
-
findPOJOBuilderClass
@Deprecated public java.lang.Class<?> findPOJOBuilderClass()
Deprecated.
-
collectAll
protected void collectAll()
Internal method that will collect actual property information.- Since:
- 2.6
-
_addFields
protected void _addFields(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method for collecting basic information on all fields found
-
_addCreators
protected void _addCreators(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method for collecting basic information on constructor(s) found
-
_addCreatorParam
protected void _addCreatorParam(java.util.Map<java.lang.String,POJOPropertyBuilder> props, AnnotatedParameter param)
- Since:
- 2.4
-
_addMethods
protected void _addMethods(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method for collecting basic information on all fields found
-
_addGetterMethod
protected void _addGetterMethod(java.util.Map<java.lang.String,POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)
-
_addSetterMethod
protected void _addSetterMethod(java.util.Map<java.lang.String,POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)
-
_addInjectables
protected void _addInjectables(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
-
_doAddInjectable
protected void _doAddInjectable(com.fasterxml.jackson.annotation.JacksonInject.Value injectable, AnnotatedMember m)
-
_removeUnwantedProperties
protected void _removeUnwantedProperties(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
Method called to get rid of candidate properties that are marked as ignored.
-
_removeUnwantedAccessor
protected void _removeUnwantedAccessor(java.util.Map<java.lang.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).
-
_collectIgnorals
protected void _collectIgnorals(java.lang.String name)
Helper method called to add explicitly ignored properties to a list of known ignored properties; this helps in proper reporting of errors.
-
_renameProperties
protected void _renameProperties(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
-
_renameUsing
protected void _renameUsing(java.util.Map<java.lang.String,POJOPropertyBuilder> propMap, PropertyNamingStrategy naming)
-
_renameWithWrappers
protected void _renameWithWrappers(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
-
_sortProperties
protected void _sortProperties(java.util.Map<java.lang.String,POJOPropertyBuilder> props)
-
reportProblem
protected void reportProblem(java.lang.String msg, java.lang.Object... args)
-
_property
protected POJOPropertyBuilder _property(java.util.Map<java.lang.String,POJOPropertyBuilder> props, PropertyName name)
-
_property
protected POJOPropertyBuilder _property(java.util.Map<java.lang.String,POJOPropertyBuilder> props, java.lang.String implName)
-
_updateCreatorProperty
@Deprecated protected void _updateCreatorProperty(POJOPropertyBuilder prop, java.util.List<POJOPropertyBuilder> creatorProperties)
Deprecated.
-
_replaceCreatorProperty
protected boolean _replaceCreatorProperty(POJOPropertyBuilder prop, java.util.List<POJOPropertyBuilder> creatorProperties)
-
-