Class BeanDescription
java.lang.Object
edu.internet2.middleware.grouperClientExt.com.fasterxml.jackson.databind.BeanDescription
- Direct Known Subclasses:
BasicBeanDescription
Basic container for information gathered by
ClassIntrospector
to
help in constructing serializers and deserializers.
Note that the main implementation type is
BasicBeanDescription
,
meaning that it is safe to upcast to this type.-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract TypeBindings
Deprecated.Since 2.7, should not need to access bindings directlyabstract AnnotatedMember
Deprecated.Since 2.9: usefindAnySetterAccessor()
insteadabstract AnnotatedMember
Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implementsJsonAnySetter
.Deprecated.Since 2.9: usefindAnySetterAccessor()
insteadabstract Map<String,
AnnotatedMember> Deprecated.Since 2.9 usefindBackReferences()
insteadabstract List<BeanPropertyDefinition>
Method for locating all back-reference properties (setters, fields) bean hasAccessor for possible description for the bean type, used for constructing documentation.abstract AnnotatedConstructor
Method that will locate the no-arg constructor for this class, if it has one, and that constructor has not been marked as ignorable.abstract 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.abstract JsonFormat.Value
findExpectedFormat
(JsonFormat.Value defValue) Method for checking what is the expected format for POJO, as defined by defaults and possible annotations.abstract Method
findFactoryMethod
(Class<?>... expArgTypes) Deprecated.Since 2.13: instead usegetFactoryMethods()
, filter.abstract Map<Object,
AnnotatedMember> Method for locating accessor (readable field, or "getter" method) that hasJsonKey
annotation, if any.abstract AnnotatedMember
Method for locating accessor (readable field, or "getter" method) that hasJsonValue
annotation, if any.abstract AnnotatedMethod
Deprecated.abstract AnnotatedMethod
findMethod
(String name, Class<?>[] paramTypes) abstract 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.abstract JsonPOJOBuilder.Value
Method for finding configuration for POJO Builder class.abstract List<BeanPropertyDefinition>
abstract JsonInclude.Value
findPropertyInclusion
(JsonInclude.Value defValue) Method for finding annotation-indicated inclusion definition (if any); possibly overriding given default value.Method for findingConverter
used for serializing instances of this class.abstract Constructor<?>
findSingleArgConstructor
(Class<?>... argTypes) Deprecated.Since 2.13: instead usegetConstructors()
, filter.Class<?>
abstract Annotations
Method for accessing collection of annotations the bean class has.abstract AnnotatedClass
Method for accessing low-level information about Class this item describes.abstract List<AnnotatedConstructor>
Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has.Method similar togetConstructors()
except will also introspectJsonCreator.Mode
and filter out ones marked as not applicable and include mode (or lack thereof) for remaining constructors.abstract List<AnnotatedMethod>
Helper method that will check all static methods of the bean class that seem like factory methods eligible to be used as Creators.abstract List<AnnotatedAndMetadata<AnnotatedMethod,
JsonCreator.Mode>> Method similar togetFactoryMethods()
but will returnJsonCreator.Mode
metadata along with qualifying factory method candidates.abstract ObjectIdInfo
Accessor for getting information about Object Id expected to be used for this POJO type, if any.getType()
Method for accessing declared type of bean being introspected, including full generic type information (from declaration)abstract boolean
Method for checking whether class being described has any annotations recognized by registered annotation introspector.abstract Object
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".boolean
abstract JavaType
resolveType
(Type jdkType) Deprecated.Since 2.8, should simply callgetType
of property accessor directly.
-
Field Details
-
_type
Bean type information, including raw class and possible generics information
-
-
Constructor Details
-
BeanDescription
-
-
Method Details
-
getType
Method for accessing declared type of bean being introspected, including full generic type information (from declaration) -
getBeanClass
-
isNonStaticInnerClass
public boolean isNonStaticInnerClass()- Since:
- 2.9
-
getClassInfo
Method for accessing low-level information about Class this item describes. -
getObjectIdInfo
Accessor for getting information about Object Id expected to be used for this POJO type, if any. -
hasKnownClassAnnotations
public abstract boolean hasKnownClassAnnotations()Method for checking whether class being described has any annotations recognized by registered annotation introspector. -
bindingsForBeanType
Deprecated.Since 2.7, should not need to access bindings directlyAccessor 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. -
resolveType
Deprecated.Since 2.8, should simply callgetType
of property accessor directly.Method for resolving given JDK type, using this bean as the generic type resolution context. -
getClassAnnotations
Method for accessing collection of annotations the bean class has. -
findProperties
- Returns:
- Ordered Map with logical property name as key, and matching getter method as value.
-
getIgnoredPropertyNames
-
findBackReferences
Method for locating all back-reference properties (setters, fields) bean has- Since:
- 2.9
-
findBackReferenceProperties
Deprecated.Since 2.9 usefindBackReferences()
insteadMethod for locating all back-reference properties (setters, fields) bean has -
getConstructors
Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has. -
getConstructorsWithMode
public abstract List<AnnotatedAndMetadata<AnnotatedConstructor,JsonCreator.Mode>> getConstructorsWithMode()Method similar togetConstructors()
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
- Since:
- 2.13
-
getFactoryMethods
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
.
- Returns:
- List of static methods considered as possible Factory methods
-
getFactoryMethodsWithMode
public abstract List<AnnotatedAndMetadata<AnnotatedMethod,JsonCreator.Mode>> getFactoryMethodsWithMode()Method similar togetFactoryMethods()
but will returnJsonCreator.Mode
metadata along with qualifying factory method candidates.- Since:
- 2.13
-
findDefaultConstructor
Method that will locate the no-arg constructor for this class, if it has one, and that constructor has not been marked as ignorable. -
findSingleArgConstructor
Deprecated.Since 2.13: instead usegetConstructors()
, filter. -
findFactoryMethod
Deprecated.Since 2.13: instead usegetFactoryMethods()
, filter. -
findJsonKeyAccessor
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
- Since:
- 2.12
-
findJsonValueAccessor
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
- Since:
- 2.9
-
findAnyGetter
-
findAnySetterAccessor
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.- Since:
- 2.9
-
findMethod
-
findJsonValueMethod
Deprecated. -
findAnySetter
Deprecated.Since 2.9: usefindAnySetterAccessor()
instead -
findAnySetterField
Deprecated.Since 2.9: usefindAnySetterAccessor()
instead -
findPropertyInclusion
Method for finding annotation-indicated inclusion definition (if any); possibly overriding given default value.NOTE: does NOT use global inclusion default settings as the base, unless passed as `defValue`.
- Since:
- 2.7
-
findExpectedFormat
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.- Since:
- 2.1
-
findSerializationConverter
Method for findingConverter
used for serializing instances of this class.- Since:
- 2.2
-
findDeserializationConverter
Method for findingConverter
used for serializing instances of this class.- Since:
- 2.2
-
findClassDescription
Accessor for possible description for the bean type, used for constructing documentation.- Since:
- 2.7
-
findInjectables
-
findPOJOBuilder
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. -
findPOJOBuilderConfig
Method for finding configuration for POJO Builder class. -
instantiateBean
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".- 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.
-
findDefaultViews
Method for finding out if the POJO specifies default view(s) to use for properties, considering both per-type annotations and global default settings.- Since:
- 2.9
-