jackson-databind 2.16.0 · com.fasterxml.jackson.databind.introspect.BasicBeanDescription

Modifier and Type	Field 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

Access	Constructor 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 Type	Method and Description
protected Converter<Object, Object>	_createConverter(Object converterDef)
protected PropertyName	_findCreatorPropertyName(AnnotatedParameter param) Deprecated since 2.8
public LinkedHashMap<String, AnnotatedField>	Returns: Ordered Map with logical property name as key, and matching field as value. _findPropertyFields(Collection<String> (optional) names of properties to ignore; any fields that would be recognized as one of these properties is ignored. ignoredProperties, boolean If true, will collect serializable property fields; if false, deserializable forSerialization) Deprecated Since 2.7.2, does not seem to be used?
protected List<BeanPropertyDefinition>	_properties()
public boolean	addProperty(BeanPropertyDefinition def)
public TypeBindings	bindingsForBeanType() Implements abstract com.fasterxml.jackson.databind.BeanDescription.bindingsForBeanType. Deprecated 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.
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 Map<String, AnnotatedMember>	findBackReferenceProperties() Implements abstract com.fasterxml.jackson.databind.BeanDescription.findBackReferenceProperties. Deprecated Method for locating all back-reference properties (setters, fields) bean has
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(JsonFormat.Value defValue) 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.
public Method	findFactoryMethod(Class<?>... expArgTypes) Implements abstract com.fasterxml.jackson.databind.BeanDescription.findFactoryMethod. Deprecated
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	findJsonValueMethod() Implements abstract com.fasterxml.jackson.databind.BeanDescription.findJsonValueMethod. Deprecated
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 Constructor<?>	findSingleArgConstructor(Class<?>... argTypes) Implements abstract com.fasterxml.jackson.databind.BeanDescription.findSingleArgConstructor. Deprecated
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 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.
public JavaType	resolveType(Type jdkType) Implements abstract com.fasterxml.jackson.databind.BeanDescription.resolveType. Deprecated Method for resolving given JDK type, using this bean as the generic type resolution context.

Inherited from com.fasterxml.jackson.databind.BeanDescription:: findAnySetter findAnySetterField getBeanClass getType isNonStaticInnerClass isRecordType

_annotationIntrospector	back to summary
protected final AnnotationIntrospector _annotationIntrospector

_classInfo	back to summary
protected final AnnotatedClass _classInfo Information collected about the class introspected.

_config	back to summary
protected final MapperConfig<?> _config

_defaultViews	back to summary
protected Class<?>[] _defaultViews Since 2.9

_defaultViewsResolved	back to summary
protected boolean _defaultViewsResolved Since 2.9

_objectIdInfo	back to summary
protected ObjectIdInfo _objectIdInfo Details of Object Id to include, if any

_propCollector	back 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.

_properties	back to summary
protected List<BeanPropertyDefinition> _properties Properties collected for the POJO; initialized as needed.

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

BasicBeanDescription	back to summary
protected BasicBeanDescription(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef)

BasicBeanDescription	back 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.

BasicBeanDescription	back to summary
protected BasicBeanDescription(POJOPropertiesCollector coll)

Method Detail

_createConverter	back to summary
protected Converter<Object, Object> _createConverter(Object converterDef) Annotations @SuppressWarnings:unchecked

_findCreatorPropertyName	back to summary
protected PropertyName _findCreatorPropertyName(AnnotatedParameter param) Deprecated since 2.8 Annotations @Deprecated

_findPropertyFields	back to summary
public LinkedHashMap<String, AnnotatedField> _findPropertyFields(Collection<String> ignoredProperties, boolean forSerialization) Deprecated Since 2.7.2, does not seem to be used? Parameters ignoredProperties:Collection<String> (optional) names of properties to ignore; any fields that would be recognized as one of these properties is ignored. forSerialization:boolean If true, will collect serializable property fields; if false, deserializable Returns:LinkedHashMap<String, AnnotatedField> Ordered Map with logical property name as key, and matching field as value. Annotations @Deprecated

_findPropertyFields

back to summary

public LinkedHashMap<String, AnnotatedField> _findPropertyFields(Collection<String> ignoredProperties, boolean forSerialization)

Deprecated

Since 2.7.2, does not seem to be used?

Parameters

ignoredProperties:Collection<String>: (optional) names of properties to ignore; any fields that would be recognized as one of these properties is ignored.
forSerialization:boolean: If true, will collect serializable property fields; if false, deserializable

Returns:LinkedHashMap<String, AnnotatedField>

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

Annotations

@Deprecated

_properties	back to summary
protected List<BeanPropertyDefinition> _properties()

addProperty	back to summary
public boolean addProperty(BeanPropertyDefinition def)

bindingsForBeanType	back to summary
public TypeBindings bindingsForBeanType() Implements abstract com.fasterxml.jackson.databind.BeanDescription.bindingsForBeanType. Doc from com.fasterxml.jackson.databind.BeanDescription.bindingsForBeanType. Deprecated 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. Annotations @Override @Deprecated

bindingsForBeanType

back to summary

public TypeBindings bindingsForBeanType()

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

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

Deprecated

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.

Annotations

@Override
@Deprecated

findAnyGetter back to summary

findAnyGetter	back 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

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

findAnySetterAccessor back to summary

findAnySetterAccessor	back 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

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

findBackReferenceProperties	back to summary
public Map<String, AnnotatedMember> findBackReferenceProperties() Implements abstract com.fasterxml.jackson.databind.BeanDescription.findBackReferenceProperties. Doc from com.fasterxml.jackson.databind.BeanDescription.findBackReferenceProperties. Deprecated Method for locating all back-reference properties (setters, fields) bean has Annotations @Deprecated @Override

findBackReferenceProperties

back to summary

public Map<String, AnnotatedMember> findBackReferenceProperties()

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

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

Deprecated

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

Annotations

@Deprecated
@Override

findBackReferences	back 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

findBackReferences

back 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

findClassDescription	back 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

findClassDescription

back 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

findDefaultConstructor	back 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

findDefaultConstructor

back 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

findDefaultViews	back 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

findDefaultViews

back 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

findDeserializationConverter back to summary

findDeserializationConverter	back 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

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

findExpectedFormat	back to summary
public JsonFormat.Value findExpectedFormat(JsonFormat.Value defValue) 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

findExpectedFormat

back to summary

public JsonFormat.Value findExpectedFormat(JsonFormat.Value defValue)

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

findFactoryMethod	back to summary
public Method findFactoryMethod(Class<?>... expArgTypes) Implements abstract com.fasterxml.jackson.databind.BeanDescription.findFactoryMethod. Deprecated Annotations @Override @Deprecated

findFactoryMethod

back to summary

public Method findFactoryMethod(Class<?>... expArgTypes)

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

Deprecated

Annotations

@Override
@Deprecated

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

findInjectables	back to summary
public Map<Object, AnnotatedMember> findInjectables() Implements abstract com.fasterxml.jackson.databind.BeanDescription.findInjectables. Annotations @Override

findInjectables

back to summary

public Map<Object, AnnotatedMember> findInjectables()

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

Annotations

@Override

findJsonKeyAccessor back to summary

findJsonKeyAccessor	back 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

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

findJsonValueAccessor back to summary

findJsonValueAccessor	back 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

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

findJsonValueMethod	back to summary
public AnnotatedMethod findJsonValueMethod() Implements abstract com.fasterxml.jackson.databind.BeanDescription.findJsonValueMethod. Deprecated Annotations @Override @Deprecated

findJsonValueMethod

back to summary

public AnnotatedMethod findJsonValueMethod()

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

Deprecated

Annotations

@Override
@Deprecated

findMethod	back to summary
public AnnotatedMethod findMethod(String name, Class<?>[] paramTypes) Implements abstract com.fasterxml.jackson.databind.BeanDescription.findMethod. Annotations @Override

findMethod

back to summary

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

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

Annotations

@Override

findPOJOBuilder	back 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

findPOJOBuilder

back 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

findPOJOBuilderConfig	back 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

findPOJOBuilderConfig

back 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

findProperties	back 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

findProperties

back 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

findProperty	back to summary
public BeanPropertyDefinition findProperty(PropertyName name) Since 2.6

findPropertyInclusion	back 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

findPropertyInclusion

back 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

findSerializationConverter back to summary

findSerializationConverter	back 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

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

findSingleArgConstructor	back to summary
public Constructor<?> findSingleArgConstructor(Class<?>... argTypes) Implements abstract com.fasterxml.jackson.databind.BeanDescription.findSingleArgConstructor. Deprecated Annotations @Override @Deprecated

findSingleArgConstructor

back to summary

public Constructor<?> findSingleArgConstructor(Class<?>... argTypes)

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

Deprecated

Annotations

@Override
@Deprecated

forDeserialization	back to summary
public static BasicBeanDescription forDeserialization(POJOPropertiesCollector coll) Factory method to use for constructing an instance to use for building deserializers.

forOtherUse	back 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.

forSerialization	back to summary
public static BasicBeanDescription forSerialization(POJOPropertiesCollector coll) Factory method to use for constructing an instance to use for building serializers.

getClassAnnotations	back 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

getClassAnnotations

back 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

getClassInfo	back 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

getClassInfo

back 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

getConstructors	back 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

getConstructors

back 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

getConstructorsWithMode back 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

getFactoryMethods back 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:

Returns type compatible with bean type (same or subtype)
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

getFactoryMethodsWithMode back 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

getIgnoredPropertyNames

back to summary

public Set<String> getIgnoredPropertyNames()

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

Annotations

@Override

getObjectIdInfo

back 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

hasKnownClassAnnotations

back 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

hasProperty	back to summary
public boolean hasProperty(PropertyName name) Since 2.6

instantiateBean

back 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