BeanDescription (jackson-databind 2.14.0 API)

java.lang.Object
- com.fasterxml.jackson.databind.BeanDescription

Direct Known Subclasses:

BasicBeanDescription
```
public abstract class BeanDescription
extends Object
```
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

Fields
Modifier and Type Field and Description

protected JavaType _type
Bean type information, including raw class and possible generics information

Fields
Modifier and Type	Field and Description
`protected JavaType`	`_type` Bean type information, including raw class and possible generics information

Constructor Summary

Constructors
Modifier Constructor and Description

protected BeanDescription(JavaType type)

Constructors
Modifier	Constructor and Description
`protected`	`BeanDescription(JavaType type)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract TypeBindings`	`bindingsForBeanType()` Deprecated. Since 2.7, should not need to access bindings directly
`abstract AnnotatedMember`	`findAnyGetter()`
`AnnotatedMethod`	`findAnySetter()` Deprecated. Since 2.9: use `findAnySetterAccessor()` instead
`abstract AnnotatedMember`	`findAnySetterAccessor()` Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implements `JsonAnySetter`.
`AnnotatedMember`	`findAnySetterField()` Deprecated. Since 2.9: use `findAnySetterAccessor()` instead
`abstract Map<String,AnnotatedMember>`	`findBackReferenceProperties()` Deprecated. Since 2.9 use `findBackReferences()` instead
`abstract List<BeanPropertyDefinition>`	`findBackReferences()` Method for locating all back-reference properties (setters, fields) bean has
`String`	`findClassDescription()` Accessor for possible description for the bean type, used for constructing documentation.
`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.
`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.
`abstract Converter<Object,Object>`	`findDeserializationConverter()` Method for finding `Converter` 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 use `getFactoryMethods()`, filter.
`abstract Map<Object,AnnotatedMember>`	`findInjectables()`
`AnnotatedMember`	`findJsonKeyAccessor()` Method for locating accessor (readable field, or "getter" method) that has `JsonKey` annotation, if any.
`abstract AnnotatedMember`	`findJsonValueAccessor()` Method for locating accessor (readable field, or "getter" method) that has `JsonValue` annotation, if any.
`abstract AnnotatedMethod`	`findJsonValueMethod()` Deprecated.
`abstract AnnotatedMethod`	`findMethod(String name, Class<?>[] paramTypes)`
`abstract Class<?>`	`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.
`abstract JsonPOJOBuilder.Value`	`findPOJOBuilderConfig()` Method for finding configuration for POJO Builder class.
`abstract List<BeanPropertyDefinition>`	`findProperties()`
`abstract JsonInclude.Value`	`findPropertyInclusion(JsonInclude.Value defValue)` Method for finding annotation-indicated inclusion definition (if any); possibly overriding given default value.
`abstract Converter<Object,Object>`	`findSerializationConverter()` Method for finding `Converter` used for serializing instances of this class.
`abstract Constructor<?>`	`findSingleArgConstructor(Class<?>... argTypes)` Deprecated. Since 2.13: instead use `getConstructors()`, filter.
`Class<?>`	`getBeanClass()`
`abstract Annotations`	`getClassAnnotations()` Method for accessing collection of annotations the bean class has.
`abstract AnnotatedClass`	`getClassInfo()` Method for accessing low-level information about Class this item describes.
`abstract List<AnnotatedConstructor>`	`getConstructors()` Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has.
`abstract List<AnnotatedAndMetadata<AnnotatedConstructor,JsonCreator.Mode>>`	`getConstructorsWithMode()` Method similar to `getConstructors()` except will also introspect `JsonCreator.Mode` and filter out ones marked as not applicable and include mode (or lack thereof) for remaining constructors.
`abstract List<AnnotatedMethod>`	`getFactoryMethods()` 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>>`	`getFactoryMethodsWithMode()` Method similar to `getFactoryMethods()` but will return `JsonCreator.Mode` metadata along with qualifying factory method candidates.
`abstract Set<String>`	`getIgnoredPropertyNames()`
`abstract ObjectIdInfo`	`getObjectIdInfo()` Accessor for getting information about Object Id expected to be used for this POJO type, if any.
`JavaType`	`getType()` Method for accessing declared type of bean being introspected, including full generic type information (from declaration)
`abstract boolean`	`hasKnownClassAnnotations()` 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`	`isNonStaticInnerClass()`
`abstract JavaType`	`resolveType(Type jdkType)` Deprecated. Since 2.8, should simply call `getType` of property accessor directly.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _type
```
protected final JavaType _type
```
    Bean type information, including raw class and possible generics information
- Constructor Detail
  - BeanDescription
```
protected BeanDescription(JavaType type)
```
- Method Detail
  - getType
```
public JavaType getType()
```
    Method for accessing declared type of bean being introspected, including full generic type information (from declaration)
  - getBeanClass
```
public Class<?> getBeanClass()
```
  - isNonStaticInnerClass
```
public boolean isNonStaticInnerClass()
```
    Since:
    
    2.9
  - getClassInfo
```
public abstract AnnotatedClass getClassInfo()
```
    Method for accessing low-level information about Class this item describes.
  - getObjectIdInfo
```
public abstract ObjectIdInfo 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
public abstract TypeBindings bindingsForBeanType()
```
    Deprecated. Since 2.7, should not need to access bindings directly
    
    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.
  - resolveType
```
@Deprecated
public abstract JavaType resolveType(Type jdkType)
```
    Deprecated. Since 2.8, should simply call getType of property accessor directly.
    
    Method for resolving given JDK type, using this bean as the generic type resolution context.
  - getClassAnnotations
```
public abstract Annotations getClassAnnotations()
```
    Method for accessing collection of annotations the bean class has.
  - findProperties
```
public abstract List<BeanPropertyDefinition> findProperties()
```
    Returns:
    
    Ordered Map with logical property name as key, and matching getter method as value.
  - getIgnoredPropertyNames
```
public abstract Set<String> getIgnoredPropertyNames()
```
  - findBackReferences
```
public abstract List<BeanPropertyDefinition> findBackReferences()
```
    Method for locating all back-reference properties (setters, fields) bean has
    
    Since:
    
    2.9
  - findBackReferenceProperties
```
@Deprecated
public abstract Map<String,AnnotatedMember> findBackReferenceProperties()
```
    Deprecated. Since 2.9 use findBackReferences() instead
    
    Method for locating all back-reference properties (setters, fields) bean has
  - getConstructors
```
public abstract List<AnnotatedConstructor> 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 to getConstructors() except will also introspect JsonCreator.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
```
public abstract List<AnnotatedMethod> 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:
    1. Returns type compatible with bean type (same or subtype)
    2. Is recognized from either explicit annotation (usually @JsonCreator OR naming: names valueOf() and fromString() are recognized but only for 1-argument factory methods, and in case of fromString() argument type must further be either String or CharSequence.
    Note that caller typically applies further checks for things like visibility.
    Returns:
    
    List of static methods considered as possible Factory methods
  - getFactoryMethodsWithMode
```
public abstract List<AnnotatedAndMetadata<AnnotatedMethod,JsonCreator.Mode>> getFactoryMethodsWithMode()
```
    Method similar to getFactoryMethods() but will return JsonCreator.Mode metadata along with qualifying factory method candidates.
    
    Since:
    
    2.13
  - findDefaultConstructor
```
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.
  - findSingleArgConstructor
```
@Deprecated
public abstract Constructor<?> findSingleArgConstructor(Class<?>... argTypes)
```
    Deprecated. Since 2.13: instead use getConstructors(), filter.
  - findFactoryMethod
```
@Deprecated
public abstract Method findFactoryMethod(Class<?>... expArgTypes)
```
    Deprecated. Since 2.13: instead use getFactoryMethods(), filter.
  - findJsonKeyAccessor
```
public AnnotatedMember findJsonKeyAccessor()
```
    Method for locating accessor (readable field, or "getter" method) that has JsonKey annotation, if any. If multiple ones are found, an error is reported by throwing IllegalArgumentException
    
    Since:
    
    2.12
  - findJsonValueAccessor
```
public abstract AnnotatedMember findJsonValueAccessor()
```
    Method for locating accessor (readable field, or "getter" method) that has JsonValue annotation, if any. If multiple ones are found, an error is reported by throwing IllegalArgumentException
    
    Since:
    
    2.9
  - findAnyGetter
```
public abstract AnnotatedMember findAnyGetter()
```
  - findAnySetterAccessor
```
public abstract AnnotatedMember findAnySetterAccessor()
```
    Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implements JsonAnySetter. 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
```
public abstract AnnotatedMethod findMethod(String name,
                                           Class<?>[] paramTypes)
```
  - findJsonValueMethod
```
@Deprecated
public abstract AnnotatedMethod findJsonValueMethod()
```
    Deprecated.
  - findAnySetter
```
@Deprecated
public AnnotatedMethod findAnySetter()
```
    Deprecated. Since 2.9: use findAnySetterAccessor() instead
  - findAnySetterField
```
@Deprecated
public AnnotatedMember findAnySetterField()
```
    Deprecated. Since 2.9: use findAnySetterAccessor() instead
  - findPropertyInclusion
```
public abstract JsonInclude.Value findPropertyInclusion(JsonInclude.Value defValue)
```
    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
```
public abstract JsonFormat.Value findExpectedFormat(JsonFormat.Value defValue)
```
    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
```
public abstract Converter<Object,Object> findSerializationConverter()
```
    Method for finding Converter used for serializing instances of this class.
    
    Since:
    
    2.2
  - findDeserializationConverter
```
public abstract Converter<Object,Object> findDeserializationConverter()
```
    Method for finding Converter used for serializing instances of this class.
    
    Since:
    
    2.2
  - findClassDescription
```
public String findClassDescription()
```
    Accessor for possible description for the bean type, used for constructing documentation.
    
    Since:
    
    2.7
  - findInjectables
```
public abstract Map<Object,AnnotatedMember> findInjectables()
```
  - findPOJOBuilder
```
public abstract Class<?> 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
```
public abstract JsonPOJOBuilder.Value findPOJOBuilderConfig()
```
    Method for finding configuration for POJO Builder class.
  - instantiateBean
```
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".
    
    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
```
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.
    
    Since:
    
    2.9

Class BeanDescription

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_type

Constructor Detail

BeanDescription

Method Detail

getType

getBeanClass

isNonStaticInnerClass

getClassInfo

getObjectIdInfo

hasKnownClassAnnotations

bindingsForBeanType

resolveType

getClassAnnotations

findProperties

getIgnoredPropertyNames

findBackReferences

findBackReferenceProperties

getConstructors

getConstructorsWithMode

getFactoryMethods

getFactoryMethodsWithMode

findDefaultConstructor

findSingleArgConstructor

findFactoryMethod

findJsonKeyAccessor

findJsonValueAccessor

findAnyGetter

findAnySetterAccessor

findMethod

findJsonValueMethod

findAnySetter

findAnySetterField

findPropertyInclusion

findExpectedFormat

findSerializationConverter

findDeserializationConverter

findClassDescription

findInjectables

findPOJOBuilder

findPOJOBuilderConfig

instantiateBean

findDefaultViews