Class BasicBeanDescription
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanDescription
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.introspect.BasicBeanDescription
Default
BeanDescription
implementation used by Jackson.
Although sub-classing is a theoretical possibility there are no known use cases for that, nor is such usage tested or supported. Separation from API is mostly to isolate some implementation details here and keep API simple.
-
Field Summary
Modifier and TypeFieldDescriptionprotected final AnnotationIntrospector
protected final AnnotatedClass
Information collected about the class introspected.protected final MapperConfig<?>
protected Class<?>[]
protected boolean
protected ObjectIdInfo
Details of Object Id to include, if anyprotected final POJOPropertiesCollector
We will hold a reference to the collector in cases where information is lazily accessed and constructed; properties are only accessed when they are actually needed.protected List<BeanPropertyDefinition>
Properties collected for the POJO; initialized as needed.Fields inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanDescription
_type
-
Constructor Summary
ModifierConstructorDescriptionprotected
BasicBeanDescription
(MapperConfig<?> config, JavaType type, AnnotatedClass classDef, List<BeanPropertyDefinition> props) Alternate constructor used in cases where property information is not needed, only class info.protected
protected
BasicBeanDescription
(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef) -
Method Summary
Modifier and TypeMethodDescription_createConverter
(Object converterDef) protected PropertyName
Deprecated.since 2.8_findPropertyFields
(Collection<String> ignoredProperties, boolean forSerialization) Deprecated.Since 2.7.2, does not seem to be used?protected List<BeanPropertyDefinition>
boolean
Deprecated.Method used to locate the method of introspected class that implementsJsonAnyGetter
.Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implementsJsonAnySetter
.Deprecated.Method for locating all back-reference properties (setters, fields) bean hasAccessor for possible description for the bean type, used for constructing documentation.Method that will locate the no-arg constructor for this class, if it has one, and that constructor has not been marked as ignorable.Class<?>[]
Method for finding out if the POJO specifies default view(s) to use for properties, considering both per-type annotations and global default settings.Method for findingConverter
used for serializing instances of this class.findExpectedFormat
(JsonFormat.Value defValue) Method for checking what is the expected format for POJO, as defined by defaults and possible annotations.findFactoryMethod
(Class<?>... expArgTypes) Deprecated.protected AnnotatedAndMetadata<AnnotatedMethod,
JsonCreator.Mode> Method for locating accessor (readable field, or "getter" method) that hasJsonKey
annotation, if any.Method for locating accessor (readable field, or "getter" method) that hasJsonValue
annotation, if any.Deprecated.findMethod
(String name, Class<?>[] paramTypes) Class<?>
Method for checking if the POJO type has annotations to indicate that a builder is to be used for instantiating instances and handling data binding, instead of standard bean deserializer.Method for finding configuration for POJO Builder class.findProperty
(PropertyName name) findPropertyInclusion
(JsonInclude.Value defValue) Method for determining whether null properties should be written out for a Bean of introspected type.Method for findingConverter
used for serializing instances of this class.Constructor<?>
findSingleArgConstructor
(Class<?>... argTypes) Deprecated.static BasicBeanDescription
Factory method to use for constructing an instance to use for building deserializers.static BasicBeanDescription
forOtherUse
(MapperConfig<?> config, JavaType type, AnnotatedClass ac) Factory method to use for constructing an instance to use for purposes other than building serializers or deserializers; will only have information on class, not on properties.static BasicBeanDescription
Factory method to use for constructing an instance to use for building serializers.Method for accessing collection of annotations the bean class has.Method for accessing low-level information about Class this item describes.Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has.Method similar toBeanDescription.getConstructors()
except will also introspectJsonCreator.Mode
and filter out ones marked as not applicable and include mode (or lack thereof) for remaining constructors.Helper method that will check all static methods of the bean class that seem like factory methods eligible to be used as Creators.Method similar toBeanDescription.getFactoryMethods()
but will returnJsonCreator.Mode
metadata along with qualifying factory method candidates.Accessor for getting information about Object Id expected to be used for this POJO type, if any.boolean
Method for checking whether class being described has any annotations recognized by registered annotation introspector.boolean
hasProperty
(PropertyName name) instantiateBean
(boolean fixAccess) Method called to create a "default instance" of the bean, currently only needed for obtaining default field values which may be used for suppressing serialization of fields that have "not changed".protected boolean
boolean
removeProperty
(String propName) Method that can be used to prune unwanted properties, during construction of serializers and deserializers.resolveType
(Type jdkType) Deprecated.Methods inherited from class edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanDescription
findAnySetter, findAnySetterField, getBeanClass, getType, isNonStaticInnerClass
-
Field Details
-
_propCollector
We will hold a reference to the collector in cases where information is lazily accessed and constructed; properties are only accessed when they are actually needed. -
_config
-
_annotationIntrospector
-
_classInfo
Information collected about the class introspected. -
_defaultViews
- Since:
- 2.9
-
_defaultViewsResolved
protected boolean _defaultViewsResolved- Since:
- 2.9
-
_properties
Properties collected for the POJO; initialized as needed. -
_objectIdInfo
Details of Object Id to include, if any
-
-
Constructor Details
-
BasicBeanDescription
protected BasicBeanDescription(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef) -
BasicBeanDescription
protected BasicBeanDescription(MapperConfig<?> config, JavaType type, AnnotatedClass classDef, List<BeanPropertyDefinition> props) Alternate constructor used in cases where property information is not needed, only class info. -
BasicBeanDescription
-
-
Method Details
-
forDeserialization
Factory method to use for constructing an instance to use for building deserializers. -
forSerialization
Factory method to use for constructing an instance to use for building serializers. -
forOtherUse
public static BasicBeanDescription forOtherUse(MapperConfig<?> config, JavaType type, AnnotatedClass ac) Factory method to use for constructing an instance to use for purposes other than building serializers or deserializers; will only have information on class, not on properties. -
_properties
-
removeProperty
Method that can be used to prune unwanted properties, during construction of serializers and deserializers. Use with utmost care, if at all...- Since:
- 2.1
-
addProperty
-
hasProperty
- Since:
- 2.6
-
findProperty
- Since:
- 2.6
-
getClassInfo
Description copied from class:BeanDescription
Method for accessing low-level information about Class this item describes.- Specified by:
getClassInfo
in classBeanDescription
-
getObjectIdInfo
Description copied from class:BeanDescription
Accessor for getting information about Object Id expected to be used for this POJO type, if any.- Specified by:
getObjectIdInfo
in classBeanDescription
-
findProperties
- Specified by:
findProperties
in classBeanDescription
- Returns:
- Ordered Map with logical property name as key, and matching getter method as value.
-
findJsonKeyAccessor
Description copied from class:BeanDescription
Method for locating accessor (readable field, or "getter" method) that hasJsonKey
annotation, if any. If multiple ones are found, an error is reported by throwingIllegalArgumentException
- Overrides:
findJsonKeyAccessor
in classBeanDescription
-
findJsonValueMethod
Deprecated.- Specified by:
findJsonValueMethod
in classBeanDescription
-
findJsonValueAccessor
Description copied from class:BeanDescription
Method for locating accessor (readable field, or "getter" method) that hasJsonValue
annotation, if any. If multiple ones are found, an error is reported by throwingIllegalArgumentException
- Specified by:
findJsonValueAccessor
in classBeanDescription
-
getIgnoredPropertyNames
- Specified by:
getIgnoredPropertyNames
in classBeanDescription
-
hasKnownClassAnnotations
public boolean hasKnownClassAnnotations()Description copied from class:BeanDescription
Method for checking whether class being described has any annotations recognized by registered annotation introspector.- Specified by:
hasKnownClassAnnotations
in classBeanDescription
-
getClassAnnotations
Description copied from class:BeanDescription
Method for accessing collection of annotations the bean class has.- Specified by:
getClassAnnotations
in classBeanDescription
-
bindingsForBeanType
Deprecated.Description copied from class:BeanDescription
Accessor for type bindings that may be needed to fully resolve types of member object, such as return and argument types of methods and constructors, and types of fields.- Specified by:
bindingsForBeanType
in classBeanDescription
-
resolveType
Deprecated.Description copied from class:BeanDescription
Method for resolving given JDK type, using this bean as the generic type resolution context.- Specified by:
resolveType
in classBeanDescription
-
findDefaultConstructor
Description copied from class:BeanDescription
Method that will locate the no-arg constructor for this class, if it has one, and that constructor has not been marked as ignorable.- Specified by:
findDefaultConstructor
in classBeanDescription
-
findAnySetterAccessor
Description copied from class:BeanDescription
Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implementsJsonAnySetter
. If no such mutator exists null is returned. If more than one are found, an exception is thrown. Additional checks are also made to see that method signature is acceptable: needs to take 2 arguments, first one String or Object; second any can be any type.- Specified by:
findAnySetterAccessor
in classBeanDescription
- Throws:
IllegalArgumentException
-
findInjectables
- Specified by:
findInjectables
in classBeanDescription
-
getConstructors
Description copied from class:BeanDescription
Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has.- Specified by:
getConstructors
in classBeanDescription
-
getConstructorsWithMode
Description copied from class:BeanDescription
Method similar toBeanDescription.getConstructors()
except will also introspectJsonCreator.Mode
and filter out ones marked as not applicable and include mode (or lack thereof) for remaining constructors.Note that no other filtering (regarding visibility or other annotations) is performed
- Specified by:
getConstructorsWithMode
in classBeanDescription
-
instantiateBean
Description copied from class:BeanDescription
Method called to create a "default instance" of the bean, currently only needed for obtaining default field values which may be used for suppressing serialization of fields that have "not changed".- Specified by:
instantiateBean
in classBeanDescription
- Parameters:
fixAccess
- If true, method is allowed to fix access to the default constructor (to be able to call non-public constructor); if false, has to use constructor as is.- Returns:
- Instance of class represented by this descriptor, if suitable default constructor was found; null otherwise.
-
findMethod
- Specified by:
findMethod
in classBeanDescription
-
findExpectedFormat
Description copied from class:BeanDescription
Method for checking what is the expected format for POJO, as defined by defaults and possible annotations. Note that this may be further refined by per-property annotations.- Specified by:
findExpectedFormat
in classBeanDescription
-
findDefaultViews
Description copied from class:BeanDescription
Method for finding out if the POJO specifies default view(s) to use for properties, considering both per-type annotations and global default settings.- Specified by:
findDefaultViews
in classBeanDescription
-
findSerializationConverter
Description copied from class:BeanDescription
Method for findingConverter
used for serializing instances of this class.- Specified by:
findSerializationConverter
in classBeanDescription
-
findPropertyInclusion
Method for determining whether null properties should be written out for a Bean of introspected type. This is based on global feature (lowest priority, passed as argument) and per-class annotation (highest priority).- Specified by:
findPropertyInclusion
in classBeanDescription
-
findAnyGetter
Method used to locate the method of introspected class that implementsJsonAnyGetter
. If no such method exists null is returned. If more than one are found, an exception is thrown.- Specified by:
findAnyGetter
in classBeanDescription
- Throws:
IllegalArgumentException
-
findBackReferences
Description copied from class:BeanDescription
Method for locating all back-reference properties (setters, fields) bean has- Specified by:
findBackReferences
in classBeanDescription
-
findBackReferenceProperties
Deprecated.Description copied from class:BeanDescription
Method for locating all back-reference properties (setters, fields) bean has- Specified by:
findBackReferenceProperties
in classBeanDescription
-
getFactoryMethods
Description copied from class:BeanDescription
Helper method that will check all static methods of the bean class that seem like factory methods eligible to be used as Creators. This requires that the static method:- Returns type compatible with bean type (same or subtype)
- Is recognized from either explicit annotation (usually
@JsonCreator
OR naming: namesvalueOf()
andfromString()
are recognized but only for 1-argument factory methods, and in case offromString()
argument type must further be eitherString
orCharSequence
.
- Specified by:
getFactoryMethods
in classBeanDescription
- Returns:
- List of static methods considered as possible Factory methods
-
getFactoryMethodsWithMode
Description copied from class:BeanDescription
Method similar toBeanDescription.getFactoryMethods()
but will returnJsonCreator.Mode
metadata along with qualifying factory method candidates.- Specified by:
getFactoryMethodsWithMode
in classBeanDescription
-
findSingleArgConstructor
Deprecated.- Specified by:
findSingleArgConstructor
in classBeanDescription
-
findFactoryMethod
Deprecated.- Specified by:
findFactoryMethod
in classBeanDescription
-
isFactoryMethod
-
findFactoryMethodMetadata
protected AnnotatedAndMetadata<AnnotatedMethod,JsonCreator.Mode> findFactoryMethodMetadata(AnnotatedMethod am) -
_findCreatorPropertyName
Deprecated.since 2.8 -
findPOJOBuilder
Description copied from class:BeanDescription
Method for checking if the POJO type has annotations to indicate that a builder is to be used for instantiating instances and handling data binding, instead of standard bean deserializer.- Specified by:
findPOJOBuilder
in classBeanDescription
-
findPOJOBuilderConfig
Description copied from class:BeanDescription
Method for finding configuration for POJO Builder class.- Specified by:
findPOJOBuilderConfig
in classBeanDescription
-
findDeserializationConverter
Description copied from class:BeanDescription
Method for findingConverter
used for serializing instances of this class.- Specified by:
findDeserializationConverter
in classBeanDescription
-
findClassDescription
Description copied from class:BeanDescription
Accessor for possible description for the bean type, used for constructing documentation.- Overrides:
findClassDescription
in classBeanDescription
-
_findPropertyFields
@Deprecated public LinkedHashMap<String,AnnotatedField> _findPropertyFields(Collection<String> ignoredProperties, boolean forSerialization) Deprecated.Since 2.7.2, does not seem to be used?- Parameters:
ignoredProperties
- (optional) names of properties to ignore; any fields that would be recognized as one of these properties is ignored.forSerialization
- If true, will collect serializable property fields; if false, deserializable- Returns:
- Ordered Map with logical property name as key, and matching field as value.
-
_createConverter
-