Top Description Fields Constructors Methods
com.fasterxml.jackson.databind.introspect

public Class BasicBeanDescription

extends BeanDescription
Class Inheritance
Imports
java.util.*, com.fasterxml.jackson.annotation.JsonCreator, .JsonFormat, .JsonInclude, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder, com.fasterxml.jackson.databind.cfg.HandlerInstantiator, .MapperConfig, com.fasterxml.jackson.databind.util.Annotations, .ClassUtil, .Converter
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 TypeField and Description
protected final AnnotationIntrospector
_annotationIntrospector

protected final AnnotatedClass
_classInfo

Information collected about the class introspected.

protected final MapperConfig<?>
_config

protected Class<?>[]
_defaultViews

protected boolean
_defaultViewsResolved

protected ObjectIdInfo
_objectIdInfo

Details of Object Id to include, if any

protected final POJOPropertiesCollector
_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.

protected List<BeanPropertyDefinition>
_properties

Properties collected for the POJO; initialized as needed.

private static final Class<?>[]
NO_VIEWS

Inherited from com.fasterxml.jackson.databind.BeanDescription:
_type

Constructor Summary

AccessConstructor and Description
protected
BasicBeanDescription(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef)

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.

protected
BasicBeanDescription(POJOPropertiesCollector coll)

Method Summary

Modifier and TypeMethod and Description
protected Converter<Object, Object>
_createConverter(Object converterDef)

protected List<BeanPropertyDefinition>
_properties()

public boolean
addProperty(BeanPropertyDefinition def)

public AnnotatedMember
findAnyGetter()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findAnyGetter.

Method used to locate the method of introspected class that implements com.fasterxml.jackson.annotation.JsonAnyGetter.

public AnnotatedMember
findAnySetterAccessor()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findAnySetterAccessor.

Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implements com.fasterxml.jackson.annotation.JsonAnySetter.

public List<BeanPropertyDefinition>
findBackReferences()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findBackReferences.

Method for locating all back-reference properties (setters, fields) bean has

public String
findClassDescription()

Overrides com.fasterxml.jackson.databind.BeanDescription.findClassDescription.

Accessor for possible description for the bean type, used for constructing documentation.

public AnnotatedConstructor
findDefaultConstructor()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.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 Class<?>[]
findDefaultViews()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.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 Converter<Object, Object>
findDeserializationConverter()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findDeserializationConverter.

Method for finding Converter used for serializing instances of this class.

public JsonFormat.Value
findExpectedFormat()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findExpectedFormat.

Method for checking what is the expected format for POJO, as defined by defaults and possible annotations.

protected AnnotatedAndMetadata<AnnotatedMethod, JsonCreator.Mode>
findFactoryMethodMetadata(AnnotatedMethod am)

public Map<Object, AnnotatedMember>
findInjectables()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findInjectables.

public AnnotatedMember
findJsonKeyAccessor()

Overrides com.fasterxml.jackson.databind.BeanDescription.findJsonKeyAccessor.

Method for locating accessor (readable field, or "getter" method) that has com.fasterxml.jackson.annotation.JsonKey annotation, if any.

public AnnotatedMember
findJsonValueAccessor()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findJsonValueAccessor.

Method for locating accessor (readable field, or "getter" method) that has com.fasterxml.jackson.annotation.JsonValue annotation, if any.

public AnnotatedMethod
findMethod(String name, Class<?>[] paramTypes)

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findMethod.

public Class<?>
findPOJOBuilder()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.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.

public JsonPOJOBuilder.Value
findPOJOBuilderConfig()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findPOJOBuilderConfig.

Method for finding configuration for POJO Builder class.

public List<BeanPropertyDefinition>
findProperties()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findProperties.

public BeanPropertyDefinition
findProperty(PropertyName name)

public JsonInclude.Value
findPropertyInclusion(JsonInclude.Value defValue)

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findPropertyInclusion.

Method for determining whether null properties should be written out for a Bean of introspected type.

public Converter<Object, Object>
findSerializationConverter()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findSerializationConverter.

Method for finding Converter used for serializing instances of this class.

public static BasicBeanDescription
forDeserialization(POJOPropertiesCollector coll)

Factory method to use for constructing an instance to use for building deserializers.

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.

public static BasicBeanDescription
forSerialization(POJOPropertiesCollector coll)

Factory method to use for constructing an instance to use for building serializers.

public Annotations
getClassAnnotations()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getClassAnnotations.

Method for accessing collection of annotations the bean class has.

public AnnotatedClass
getClassInfo()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getClassInfo.

Method for accessing low-level information about Class this item describes.

public List<AnnotatedConstructor>
getConstructors()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getConstructors.

Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has.

public List<AnnotatedAndMetadata<AnnotatedConstructor, JsonCreator.Mode>>
getConstructorsWithMode()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.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.

public List<AnnotatedMethod>
getFactoryMethods()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getFactoryMethods.

Helper method that will check all static methods of the bean class that seem like factory methods eligible to be used as Creators.

public List<AnnotatedAndMetadata<AnnotatedMethod, JsonCreator.Mode>>
getFactoryMethodsWithMode()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getFactoryMethodsWithMode.

Method similar to getFactoryMethods() but will return JsonCreator.Mode metadata along with qualifying factory method candidates.

public Set<String>
getIgnoredPropertyNames()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getIgnoredPropertyNames.

public ObjectIdInfo
getObjectIdInfo()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getObjectIdInfo.

Accessor for getting information about Object Id expected to be used for this POJO type, if any.

public PotentialCreators
getPotentialCreators()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getPotentialCreators.

Method that is replacing earlier Creator introspection access methods.

public boolean
hasKnownClassAnnotations()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.hasKnownClassAnnotations.

Method for checking whether class being described has any annotations recognized by registered annotation introspector.

public boolean
hasProperty(PropertyName name)

public Object
instantiateBean(boolean
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)

Implements abstract com.fasterxml.jackson.databind.BeanDescription.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".

protected boolean
isFactoryMethod(AnnotatedMethod am)

public boolean
removeProperty(String propName)

Method that can be used to prune unwanted properties, during construction of serializers and deserializers.

Inherited from com.fasterxml.jackson.databind.BeanDescription:
bindingsForBeanTypefindAnySetterfindAnySetterFieldfindBackReferencePropertiesfindExpectedFormatfindFactoryMethodfindJsonValueMethodfindSingleArgConstructorgetBeanClassgetTypeisNonStaticInnerClassisRecordTyperesolveType

Field Detail

_annotationIntrospectorback to summary
protected final AnnotationIntrospector _annotationIntrospector
_classInfoback to summary
protected final AnnotatedClass _classInfo

Information collected about the class introspected.

_configback to summary
protected final MapperConfig<?> _config
_defaultViewsback to summary
protected Class<?>[] _defaultViews
Since
2.9
_defaultViewsResolvedback to summary
protected boolean _defaultViewsResolved
Since
2.9
_objectIdInfoback to summary
protected ObjectIdInfo _objectIdInfo

Details of Object Id to include, if any

_propCollectorback to summary
protected final POJOPropertiesCollector _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.

_propertiesback to summary
protected List<BeanPropertyDefinition> _properties

Properties collected for the POJO; initialized as needed.

NO_VIEWSback to summary
private static final Class<?>[] NO_VIEWS

Constructor Detail

BasicBeanDescriptionback to summary
protected BasicBeanDescription(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef)
BasicBeanDescriptionback to summary
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.

BasicBeanDescriptionback to summary
protected BasicBeanDescription(POJOPropertiesCollector coll)

Method Detail

_createConverterback to summary
protected Converter<Object, Object> _createConverter(Object converterDef)
Annotations
@SuppressWarnings:unchecked
_propertiesback to summary
protected List<BeanPropertyDefinition> _properties()
addPropertyback to summary
public boolean addProperty(BeanPropertyDefinition def)
findAnyGetterback to summary
public AnnotatedMember findAnyGetter() throws IllegalArgumentException

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findAnyGetter.

Method used to locate the method of introspected class that implements com.fasterxml.jackson.annotation.JsonAnyGetter. If no such method exists null is returned. If more than one are found, an exception is thrown.

Annotations
@Override
findAnySetterAccessorback to summary
public AnnotatedMember findAnySetterAccessor() throws IllegalArgumentException

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findAnySetterAccessor.

Doc from com.fasterxml.jackson.databind.BeanDescription.findAnySetterAccessor.

Method used to locate a mutator (settable field, or 2-argument set method) of introspected class that implements com.fasterxml.jackson.annotation.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.

Annotations
@Override
findBackReferencesback to summary
public List<BeanPropertyDefinition> findBackReferences()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findBackReferences.

Doc from com.fasterxml.jackson.databind.BeanDescription.findBackReferences.

Method for locating all back-reference properties (setters, fields) bean has

Annotations
@Override
findClassDescriptionback to summary
public String findClassDescription()

Overrides com.fasterxml.jackson.databind.BeanDescription.findClassDescription.

Doc from com.fasterxml.jackson.databind.BeanDescription.findClassDescription.

Accessor for possible description for the bean type, used for constructing documentation.

Annotations
@Override
findDefaultConstructorback to summary
public AnnotatedConstructor findDefaultConstructor()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findDefaultConstructor.

Doc from com.fasterxml.jackson.databind.BeanDescription.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.

Annotations
@Override
findDefaultViewsback to summary
public Class<?>[] findDefaultViews()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findDefaultViews.

Doc from com.fasterxml.jackson.databind.BeanDescription.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.

Annotations
@Override
findDeserializationConverterback to summary
public Converter<Object, Object> findDeserializationConverter()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findDeserializationConverter.

Doc from com.fasterxml.jackson.databind.BeanDescription.findDeserializationConverter.

Method for finding Converter used for serializing instances of this class.

Annotations
@Override
findExpectedFormatback to summary
public JsonFormat.Value findExpectedFormat()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findExpectedFormat.

Doc from com.fasterxml.jackson.databind.BeanDescription.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.

Annotations
@Override
findFactoryMethodMetadataback to summary
protected AnnotatedAndMetadata<AnnotatedMethod, JsonCreator.Mode> findFactoryMethodMetadata(AnnotatedMethod am)
findInjectablesback to summary
public Map<Object, AnnotatedMember> findInjectables()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findInjectables.

Annotations
@Override
findJsonKeyAccessorback to summary
public AnnotatedMember findJsonKeyAccessor()

Overrides com.fasterxml.jackson.databind.BeanDescription.findJsonKeyAccessor.

Doc from com.fasterxml.jackson.databind.BeanDescription.findJsonKeyAccessor.

Method for locating accessor (readable field, or "getter" method) that has com.fasterxml.jackson.annotation.JsonKey annotation, if any. If multiple ones are found, an error is reported by throwing IllegalArgumentException

Annotations
@Override
findJsonValueAccessorback to summary
public AnnotatedMember findJsonValueAccessor()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findJsonValueAccessor.

Doc from com.fasterxml.jackson.databind.BeanDescription.findJsonValueAccessor.

Method for locating accessor (readable field, or "getter" method) that has com.fasterxml.jackson.annotation.JsonValue annotation, if any. If multiple ones are found, an error is reported by throwing IllegalArgumentException

Annotations
@Override
findMethodback to summary
public AnnotatedMethod findMethod(String name, Class<?>[] paramTypes)

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findMethod.

Annotations
@Override
findPOJOBuilderback to summary
public Class<?> findPOJOBuilder()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findPOJOBuilder.

Doc from com.fasterxml.jackson.databind.BeanDescription.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.

Annotations
@Override
findPOJOBuilderConfigback to summary
public JsonPOJOBuilder.Value findPOJOBuilderConfig()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findPOJOBuilderConfig.

Doc from com.fasterxml.jackson.databind.BeanDescription.findPOJOBuilderConfig.

Method for finding configuration for POJO Builder class.

Annotations
@Override
findPropertiesback to summary
public List<BeanPropertyDefinition> findProperties()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findProperties.

Returns:List<BeanPropertyDefinition>

Doc from com.fasterxml.jackson.databind.BeanDescription.findProperties.

Ordered Map with logical property name as key, and matching getter method as value.

Annotations
@Override
findPropertyback to summary
public BeanPropertyDefinition findProperty(PropertyName name)
Since
2.6
findPropertyInclusionback to summary
public JsonInclude.Value findPropertyInclusion(JsonInclude.Value defValue)

Implements abstract com.fasterxml.jackson.databind.BeanDescription.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).

Annotations
@Override
findSerializationConverterback to summary
public Converter<Object, Object> findSerializationConverter()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.findSerializationConverter.

Doc from com.fasterxml.jackson.databind.BeanDescription.findSerializationConverter.

Method for finding Converter used for serializing instances of this class.

Annotations
@Override
forDeserializationback to summary
public static BasicBeanDescription forDeserialization(POJOPropertiesCollector coll)

Factory method to use for constructing an instance to use for building deserializers.

forOtherUseback to summary
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.

forSerializationback to summary
public static BasicBeanDescription forSerialization(POJOPropertiesCollector coll)

Factory method to use for constructing an instance to use for building serializers.

getClassAnnotationsback to summary
public Annotations getClassAnnotations()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getClassAnnotations.

Doc from com.fasterxml.jackson.databind.BeanDescription.getClassAnnotations.

Method for accessing collection of annotations the bean class has.

Annotations
@Override
getClassInfoback to summary
public AnnotatedClass getClassInfo()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getClassInfo.

Doc from com.fasterxml.jackson.databind.BeanDescription.getClassInfo.

Method for accessing low-level information about Class this item describes.

Annotations
@Override
getConstructorsback to summary
public List<AnnotatedConstructor> getConstructors()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getConstructors.

Doc from com.fasterxml.jackson.databind.BeanDescription.getConstructors.

Helper method that will return all non-default constructors (that is, constructors that take one or more arguments) this class has.

Annotations
@Override
getConstructorsWithModeback to summary
public List<AnnotatedAndMetadata<AnnotatedConstructor, JsonCreator.Mode>> getConstructorsWithMode()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getConstructorsWithMode.

Doc from com.fasterxml.jackson.databind.BeanDescription.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

Annotations
@Override
getFactoryMethodsback to summary
public List<AnnotatedMethod> getFactoryMethods()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getFactoryMethods.

Doc from com.fasterxml.jackson.databind.BeanDescription.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<AnnotatedMethod>

List of static methods considered as possible Factory methods

Annotations
@Override
getFactoryMethodsWithModeback to summary
public List<AnnotatedAndMetadata<AnnotatedMethod, JsonCreator.Mode>> getFactoryMethodsWithMode()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getFactoryMethodsWithMode.

Doc from com.fasterxml.jackson.databind.BeanDescription.getFactoryMethodsWithMode.

Method similar to getFactoryMethods() but will return JsonCreator.Mode metadata along with qualifying factory method candidates.

Annotations
@Override
getIgnoredPropertyNamesback to summary
public Set<String> getIgnoredPropertyNames()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getIgnoredPropertyNames.

Annotations
@Override
getObjectIdInfoback to summary
public ObjectIdInfo getObjectIdInfo()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getObjectIdInfo.

Doc from com.fasterxml.jackson.databind.BeanDescription.getObjectIdInfo.

Accessor for getting information about Object Id expected to be used for this POJO type, if any.

Annotations
@Override
getPotentialCreatorsback to summary
public PotentialCreators getPotentialCreators()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.getPotentialCreators.

Doc from com.fasterxml.jackson.databind.BeanDescription.getPotentialCreators.

Method that is replacing earlier Creator introspection access methods.

Returns:PotentialCreators

Container for introspected Creator candidates, if any

Annotations
@Override
hasKnownClassAnnotationsback to summary
public boolean hasKnownClassAnnotations()

Implements abstract com.fasterxml.jackson.databind.BeanDescription.hasKnownClassAnnotations.

Doc from com.fasterxml.jackson.databind.BeanDescription.hasKnownClassAnnotations.

Method for checking whether class being described has any annotations recognized by registered annotation introspector.

Annotations
@Override
hasPropertyback to summary
public boolean hasProperty(PropertyName name)
Since
2.6
instantiateBeanback to summary
public Object instantiateBean(boolean fixAccess)

Implements abstract com.fasterxml.jackson.databind.BeanDescription.instantiateBean.

Doc from com.fasterxml.jackson.databind.BeanDescription.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:boolean

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:Object

Instance of class represented by this descriptor, if suitable default constructor was found; null otherwise.

Annotations
@Override
isFactoryMethodback to summary
protected boolean isFactoryMethod(AnnotatedMethod am)
removePropertyback to summary
public boolean removeProperty(String propName)

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