ClassIntrospector to
help in constructing serializers and deserializers.
Note that the one implementation type is
tools.jackson.databind.introspect.BasicBeanDescription ,
meaning that it is safe to upcast to that type.
| Modifier and Type | Class and Description |
|---|---|
| public static class | BeanDescription.
Simple |
| public abstract static class | BeanDescription.
Partial implementation for lazily-constructed suppliers for |
| public static interface | BeanDescription.
Interface for lazily-constructed suppliers for |
| protected abstract static class |
| Modifier and Type | Field and Description |
|---|---|
| protected final JavaType | _type
Bean type information, including raw class and possible generics information |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public abstract AnnotatedMember | |
| public abstract AnnotatedMember | findAnySetterAccessor()
Method used to locate a mutator (settable field, or 2-argument set method)
of introspected class that
implements |
| public abstract List | |
| public abstract AnnotatedConstructor | 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. |
| public abstract Class | 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. |
| public abstract Map | |
| public AnnotatedMember | findJsonKeyAccessor()
Method for locating accessor (readable field, or "getter" method)
that has
|
| public abstract AnnotatedMember | findJsonValueAccessor()
Method for locating accessor (readable field, or "getter" method)
that has
|
| public abstract AnnotatedMethod | |
| public abstract List | Returns: Ordered Map with logical property name as key, and matching getter method as value.
|
| public abstract JsonInclude. | findPropertyInclusion(JsonInclude.
Method for finding annotation-indicated inclusion definition (if any); possibly overriding given default value. |
| public Class | |
| public abstract Annotations | |
| public abstract AnnotatedClass | |
| public abstract List | getConstructors()
Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has. |
| public abstract List | getConstructorsWithMode()
Method similar to |
| public abstract List | Returns: List of static methods considered as possible Factory methodsHelper method that will check all static methods of the bean class that seem like factory methods eligible to be used as Creators. |
| public abstract List | getFactoryMethodsWithMode()
Method similar to |
| public abstract Set | |
| public abstract ObjectIdInfo | getObjectIdInfo()
Accessor for getting information about Object Id expected to be used for this POJO type, if any. |
| public abstract PotentialCreators | Returns: Container for introspected Creator candidates, if anyMethod that is replacing earlier Creator introspection access methods. |
| public JavaType | getType()
Method for accessing declared type of bean being introspected, including full generic type information (from declaration) |
| public abstract boolean | hasKnownClassAnnotations()
Method for checking whether class being described has any annotations recognized by registered annotation introspector. |
| public abstract Object | Returns: Instance of class represented by this descriptor, if suitable default constructor was found; null otherwise.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. 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". |
| public boolean | |
| public boolean | |
| public abstract BeanDescription. | supplier()
Method for constructing a supplier for this bean description instance: sometimes needed when code expects supplier, not description instance. |
| _type | back to summary |
|---|---|
| protected final JavaType _type Bean type information, including raw class and possible generics information | |
| BeanDescription | back to summary |
|---|---|
| protected BeanDescription(JavaType type) | |
| findAnyGetter | back to summary |
|---|---|
| public abstract AnnotatedMember findAnyGetter() | |
| findAnySetterAccessor | back to summary |
|---|---|
| public abstract AnnotatedMember findAnySetterAccessor() Method used to locate a mutator (settable field, or 2-argument set method)
of introspected class that
implements | |
| findBackReferences | back to summary |
|---|---|
| public abstract List Method for locating all back-reference properties (setters, fields) bean has | |
| findDefaultConstructor | back to summary |
|---|---|
| public abstract AnnotatedConstructor 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. | |
| findDefaultViews | back to summary |
|---|---|
| public 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. | |
| findInjectables | back to summary |
|---|---|
| public abstract Map | |
| findJsonKeyAccessor | back to summary |
|---|---|
| public AnnotatedMember findJsonKeyAccessor() Method for locating accessor (readable field, or "getter" method)
that has
| |
| findJsonValueAccessor | back to summary |
|---|---|
| public abstract AnnotatedMember findJsonValueAccessor() Method for locating accessor (readable field, or "getter" method)
that has
| |
| findMethod | back to summary |
|---|---|
| public abstract AnnotatedMethod findMethod(String name, Class<?>[] paramTypes) | |
| findProperties | back to summary |
|---|---|
public abstract List
| |
| findPropertyInclusion | back to summary |
|---|---|
| public abstract JsonInclude. 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`. | |
| getBeanClass | back to summary |
|---|---|
| public Class | |
| getClassAnnotations | back to summary |
|---|---|
| public abstract Annotations getClassAnnotations() Method for accessing collection of annotations the bean class has. | |
| getClassInfo | back to summary |
|---|---|
| public abstract AnnotatedClass getClassInfo() Method for accessing low-level information about Class this item describes. | |
| getConstructors | back to summary |
|---|---|
| public abstract List Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has. | |
| getConstructorsWithMode | back to summary |
|---|---|
| public abstract List Method similar to Note that no other filtering (regarding visibility or other annotations) is performed
| |
| getFactoryMethods | back to summary |
|---|---|
| public abstract List 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:
| |
| getFactoryMethodsWithMode | back to summary |
|---|---|
| public abstract List Method similar to
| |
| getIgnoredPropertyNames | back to summary |
|---|---|
| public abstract Set | |
| getObjectIdInfo | back to summary |
|---|---|
| public abstract ObjectIdInfo getObjectIdInfo() Accessor for getting information about Object Id expected to be used for this POJO type, if any. | |
| getPotentialCreators | back to summary |
|---|---|
| public abstract PotentialCreators getPotentialCreators() Method that is replacing earlier Creator introspection access methods.
| |
| getType | back to summary |
|---|---|
| public JavaType getType() Method for accessing declared type of bean being introspected, including full generic type information (from declaration) | |
| hasKnownClassAnnotations | back to summary |
|---|---|
| public abstract boolean hasKnownClassAnnotations() Method for checking whether class being described has any annotations recognized by registered annotation introspector. | |
| instantiateBean | back to summary |
|---|---|
| public 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".
| |
| isNonStaticInnerClass | back to summary |
|---|---|
| public boolean isNonStaticInnerClass() | |
| isRecordType | back to summary |
|---|---|
| public boolean isRecordType() | |
| supplier | back to summary |
|---|---|
| public abstract BeanDescription. Method for constructing a supplier for this bean description instance: sometimes needed when code expects supplier, not description instance. | |
Supplier implementation that just returns pre-constructed
BeanDescription instance.
| Modifier and Type | Field and Description |
|---|---|
| protected final BeanDescription |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public BeanDescription | |
| public Annotations | |
| public AnnotatedClass |
| _beanDesc | back to summary |
|---|---|
| protected final BeanDescription _beanDesc | |
| EagerSupplier | back to summary |
|---|---|
| public EagerSupplier(MapperConfig<?> config, BeanDescription beanDesc) | |
| get | back to summary |
|---|---|
| public BeanDescription get() Implements tools. Doc from java. Gets a result.
| |
| getClassAnnotations | back to summary |
|---|---|
| public Annotations getClassAnnotations() Implements tools.
| |
| getClassInfo | back to summary |
|---|---|
| public AnnotatedClass getClassInfo() Implements tools.
| |
BeanDescription instances.
| Modifier and Type | Field and Description |
|---|---|
| protected transient BeanDescription | |
| protected transient AnnotatedClass |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| protected abstract BeanDescription | |
| protected abstract AnnotatedClass | |
| public BeanDescription | |
| public Annotations | |
| public AnnotatedClass |
| _beanDesc | back to summary |
|---|---|
| protected transient BeanDescription _beanDesc | |
| _classDesc | back to summary |
|---|---|
| protected transient AnnotatedClass _classDesc | |
| LazySupplier | back to summary |
|---|---|
| protected LazySupplier(MapperConfig<?> config, JavaType type) | |
| _construct | back to summary |
|---|---|
| protected abstract BeanDescription _construct(JavaType forType, AnnotatedClass ac) | |
| _introspect | back to summary |
|---|---|
| protected abstract AnnotatedClass _introspect(JavaType forType) | |
| get | back to summary |
|---|---|
| public BeanDescription get() Implements tools. Doc from java. Gets a result.
| |
| getClassAnnotations | back to summary |
|---|---|
| public Annotations getClassAnnotations() Implements tools.
| |
| getClassInfo | back to summary |
|---|---|
| public AnnotatedClass getClassInfo() Implements tools.
| |
BeanDescription instances;
extends plain java.util.function.Supplier with convenience accessors.
| Modifier and Type | Method and Description |
|---|---|
| public JsonFormat. | |
| public BeanDescription | |
| public Class | |
| public Annotations | |
| public AnnotatedClass | |
| public JavaType | |
| public boolean |
| findExpectedFormat | back to summary |
|---|---|
| public JsonFormat. | |
| get | back to summary |
|---|---|
| public BeanDescription get() Redeclares java. Doc from java. Gets a result.
| |
| getBeanClass | back to summary |
|---|---|
| public Class | |
| getClassAnnotations | back to summary |
|---|---|
| public Annotations getClassAnnotations() | |
| getClassInfo | back to summary |
|---|---|
| public AnnotatedClass getClassInfo() | |
| getType | back to summary |
|---|---|
| public JavaType getType() | |
| isRecordType | back to summary |
|---|---|
| public boolean isRecordType() | |
| Modifier and Type | Field and Description |
|---|---|
| protected transient JsonFormat. | _classFormat
Format definitions lazily introspected from class annotations |
| protected final MapperConfig | |
| protected final JavaType |
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public JsonFormat. | findExpectedFormat(Class<?> baseType)
Implements tools.
|
| public Class | |
| public JavaType | |
| public boolean |
| _classFormat | back to summary |
|---|---|
| protected transient JsonFormat. Format definitions lazily introspected from class annotations | |
| _config | back to summary |
|---|---|
| protected final MapperConfig<?> _config | |
| _type | back to summary |
|---|---|
| protected final JavaType _type | |
| SupplierBase | back to summary |
|---|---|
| protected SupplierBase(MapperConfig<?> config, JavaType type) | |
| findExpectedFormat | back to summary |
|---|---|
| public JsonFormat. Implements tools.
| |
| getBeanClass | back to summary |
|---|---|
| public Class Implements tools.
| |
| getType | back to summary |
|---|---|
| public JavaType getType() Implements tools.
| |
| isRecordType | back to summary |
|---|---|
| public boolean isRecordType() Implements tools.
| |