public class BasicBeanDescription extends BeanDescription
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.
| Modifier and Type | Field and Description |
|---|---|
protected AnnotationIntrospector |
_annotationIntrospector |
protected AnnotatedClass |
_classInfo
Information collected about the class introspected.
|
protected MapperConfig<?> |
_config |
protected ObjectIdInfo |
_objectIdInfo
Details of Object Id to include, if any
|
protected 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 java.util.List<BeanPropertyDefinition> |
_properties
Properties collected for the POJO; initialized as needed.
|
_type| Modifier | Constructor and Description |
|---|---|
protected |
BasicBeanDescription(MapperConfig<?> config,
JavaType type,
AnnotatedClass classDef,
java.util.List<BeanPropertyDefinition> props)
Alternate constructor used in cases where property information is not needed,
only class info.
|
protected |
BasicBeanDescription(POJOPropertiesCollector coll) |
protected |
BasicBeanDescription(POJOPropertiesCollector coll,
JavaType type,
AnnotatedClass classDef) |
| Modifier and Type | Method and Description |
|---|---|
Converter<java.lang.Object,java.lang.Object> |
_createConverter(java.lang.Object converterDef) |
protected PropertyName |
_findCreatorPropertyName(AnnotatedParameter param)
Deprecated.
since 2.8
|
java.util.LinkedHashMap<java.lang.String,AnnotatedField> |
_findPropertyFields(java.util.Collection<java.lang.String> ignoredProperties,
boolean forSerialization)
Deprecated.
Since 2.7.2, does not seem to be used?
|
protected java.util.List<BeanPropertyDefinition> |
_properties() |
boolean |
addProperty(BeanPropertyDefinition def) |
TypeBindings |
bindingsForBeanType()
Deprecated.
|
AnnotatedMember |
findAnyGetter()
Method used to locate the method of introspected class that
implements
JsonAnyGetter. |
AnnotatedMethod |
findAnySetter()
Method used to locate the method of introspected class that
implements
JsonAnySetter. |
AnnotatedMember |
findAnySetterField()
Method used to locate the field of the class that implements
JsonAnySetter If no such method
exists null is returned. |
java.util.Map<java.lang.String,AnnotatedMember> |
findBackReferenceProperties()
Method for locating all back-reference properties (setters, fields) bean has
|
java.lang.String |
findClassDescription()
Accessor for possible description for the bean type, used for constructing
documentation.
|
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.
|
Converter<java.lang.Object,java.lang.Object> |
findDeserializationConverter()
Method for finding
Converter used for serializing instances
of this class. |
com.fasterxml.jackson.annotation.JsonFormat.Value |
findExpectedFormat(com.fasterxml.jackson.annotation.JsonFormat.Value defValue)
Method for checking what is the expected format for POJO, as
defined by defaults and possible annotations.
|
java.lang.reflect.Method |
findFactoryMethod(java.lang.Class<?>... expArgTypes)
Method that can be called to find if introspected class declares
a static "valueOf" factory method that returns an instance of
introspected type, given one of acceptable types.
|
java.util.Map<java.lang.Object,AnnotatedMember> |
findInjectables() |
AnnotatedMethod |
findJsonValueMethod()
Method for locating the getter method that is annotated with
JsonValue annotation,
if any. |
AnnotatedMethod |
findMethod(java.lang.String name,
java.lang.Class<?>[] paramTypes) |
java.lang.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.
|
JsonPOJOBuilder.Value |
findPOJOBuilderConfig()
Method for finding configuration for POJO Builder class.
|
java.util.List<BeanPropertyDefinition> |
findProperties() |
BeanPropertyDefinition |
findProperty(PropertyName name) |
com.fasterxml.jackson.annotation.JsonInclude.Value |
findPropertyInclusion(com.fasterxml.jackson.annotation.JsonInclude.Value defValue)
Method for determining whether null properties should be written
out for a Bean of introspected type.
|
Converter<java.lang.Object,java.lang.Object> |
findSerializationConverter()
Method for finding
Converter used for serializing instances
of this class. |
java.lang.reflect.Constructor<?> |
findSingleArgConstructor(java.lang.Class<?>... argTypes)
Method that can be called to locate a single-arg constructor that
takes specified exact type (will not accept supertype constructors)
|
static BasicBeanDescription |
forDeserialization(POJOPropertiesCollector coll)
Factory method to use for constructing an instance to use for building
deserializers.
|
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.
|
static BasicBeanDescription |
forSerialization(POJOPropertiesCollector coll)
Factory method to use for constructing an instance to use for building
serializers.
|
Annotations |
getClassAnnotations()
Method for accessing collection of annotations the bean
class has.
|
AnnotatedClass |
getClassInfo()
Method for accessing low-level information about Class this
item describes.
|
java.util.List<AnnotatedConstructor> |
getConstructors() |
java.util.List<AnnotatedMethod> |
getFactoryMethods() |
java.util.Set<java.lang.String> |
getIgnoredPropertyNames() |
ObjectIdInfo |
getObjectIdInfo()
Accessor for getting information about Object Id expected to
be used for this POJO type, if any.
|
boolean |
hasKnownClassAnnotations()
Method for checking whether class being described has any
annotations recognized by registered annotation introspector.
|
boolean |
hasProperty(PropertyName name) |
java.lang.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".
|
protected boolean |
isFactoryMethod(AnnotatedMethod am) |
boolean |
removeProperty(java.lang.String propName)
Method that can be used to prune unwanted properties, during
construction of serializers and deserializers.
|
JavaType |
resolveType(java.lang.reflect.Type jdkType)
Deprecated.
|
getBeanClass, getTypeprotected final POJOPropertiesCollector _propCollector
protected final MapperConfig<?> _config
protected final AnnotationIntrospector _annotationIntrospector
protected final AnnotatedClass _classInfo
protected java.util.List<BeanPropertyDefinition> _properties
protected ObjectIdInfo _objectIdInfo
protected BasicBeanDescription(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef)
protected BasicBeanDescription(MapperConfig<?> config, JavaType type, AnnotatedClass classDef, java.util.List<BeanPropertyDefinition> props)
protected BasicBeanDescription(POJOPropertiesCollector coll)
public static BasicBeanDescription forDeserialization(POJOPropertiesCollector coll)
public static BasicBeanDescription forSerialization(POJOPropertiesCollector coll)
public static BasicBeanDescription forOtherUse(MapperConfig<?> config, JavaType type, AnnotatedClass ac)
protected java.util.List<BeanPropertyDefinition> _properties()
public boolean removeProperty(java.lang.String propName)
public boolean addProperty(BeanPropertyDefinition def)
public boolean hasProperty(PropertyName name)
public BeanPropertyDefinition findProperty(PropertyName name)
public AnnotatedClass getClassInfo()
BeanDescriptiongetClassInfo in class BeanDescriptionpublic ObjectIdInfo getObjectIdInfo()
BeanDescriptiongetObjectIdInfo in class BeanDescriptionpublic java.util.List<BeanPropertyDefinition> findProperties()
findProperties in class BeanDescriptionpublic AnnotatedMethod findJsonValueMethod()
BeanDescriptionJsonValue annotation,
if any. If multiple ones are found,
an error is reported by throwing IllegalArgumentExceptionfindJsonValueMethod in class BeanDescriptionpublic java.util.Set<java.lang.String> getIgnoredPropertyNames()
getIgnoredPropertyNames in class BeanDescriptionpublic boolean hasKnownClassAnnotations()
BeanDescriptionhasKnownClassAnnotations in class BeanDescriptionpublic Annotations getClassAnnotations()
BeanDescriptiongetClassAnnotations in class BeanDescription@Deprecated public TypeBindings bindingsForBeanType()
BeanDescriptionbindingsForBeanType in class BeanDescription@Deprecated public JavaType resolveType(java.lang.reflect.Type jdkType)
BeanDescriptionresolveType in class BeanDescriptionpublic AnnotatedConstructor findDefaultConstructor()
BeanDescriptionfindDefaultConstructor in class BeanDescriptionpublic AnnotatedMethod findAnySetter() throws java.lang.IllegalArgumentException
BeanDescriptionJsonAnySetter. If no such method 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.findAnySetter in class BeanDescriptionjava.lang.IllegalArgumentExceptionpublic java.util.Map<java.lang.Object,AnnotatedMember> findInjectables()
findInjectables in class BeanDescriptionpublic java.util.List<AnnotatedConstructor> getConstructors()
getConstructors in class BeanDescriptionpublic java.lang.Object instantiateBean(boolean fixAccess)
BeanDescriptioninstantiateBean in class BeanDescriptionfixAccess - 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.public AnnotatedMethod findMethod(java.lang.String name, java.lang.Class<?>[] paramTypes)
findMethod in class BeanDescriptionpublic com.fasterxml.jackson.annotation.JsonFormat.Value findExpectedFormat(com.fasterxml.jackson.annotation.JsonFormat.Value defValue)
BeanDescriptionfindExpectedFormat in class BeanDescriptionpublic Converter<java.lang.Object,java.lang.Object> findSerializationConverter()
BeanDescriptionConverter used for serializing instances
of this class.findSerializationConverter in class BeanDescriptionpublic com.fasterxml.jackson.annotation.JsonInclude.Value findPropertyInclusion(com.fasterxml.jackson.annotation.JsonInclude.Value defValue)
findPropertyInclusion in class BeanDescriptionpublic AnnotatedMember findAnyGetter() throws java.lang.IllegalArgumentException
JsonAnyGetter.
If no such method exists null is returned.
If more than one are found, an exception is thrown.findAnyGetter in class BeanDescriptionjava.lang.IllegalArgumentExceptionpublic AnnotatedMember findAnySetterField() throws java.lang.IllegalArgumentException
BeanDescriptionJsonAnySetter If no such method
exists null is returned. If more than one are found, an exception is thrown.findAnySetterField in class BeanDescriptionjava.lang.IllegalArgumentExceptionpublic java.util.Map<java.lang.String,AnnotatedMember> findBackReferenceProperties()
BeanDescriptionfindBackReferenceProperties in class BeanDescriptionpublic java.util.List<AnnotatedMethod> getFactoryMethods()
getFactoryMethods in class BeanDescriptionpublic java.lang.reflect.Constructor<?> findSingleArgConstructor(java.lang.Class<?>... argTypes)
BeanDescriptionfindSingleArgConstructor in class BeanDescriptionargTypes - Type(s) of the argument that we are looking forpublic java.lang.reflect.Method findFactoryMethod(java.lang.Class<?>... expArgTypes)
BeanDescriptionfindFactoryMethod in class BeanDescriptionexpArgTypes - Types that the matching single argument factory
method can take: will also accept super types of these types
(ie. arg just has to be assignable from expArgType)protected boolean isFactoryMethod(AnnotatedMethod am)
@Deprecated protected PropertyName _findCreatorPropertyName(AnnotatedParameter param)
public java.lang.Class<?> findPOJOBuilder()
BeanDescriptionfindPOJOBuilder in class BeanDescriptionpublic JsonPOJOBuilder.Value findPOJOBuilderConfig()
BeanDescriptionfindPOJOBuilderConfig in class BeanDescriptionpublic Converter<java.lang.Object,java.lang.Object> findDeserializationConverter()
BeanDescriptionConverter used for serializing instances
of this class.findDeserializationConverter in class BeanDescriptionpublic java.lang.String findClassDescription()
BeanDescriptionfindClassDescription in class BeanDescription@Deprecated public java.util.LinkedHashMap<java.lang.String,AnnotatedField> _findPropertyFields(java.util.Collection<java.lang.String> ignoredProperties, boolean forSerialization)
ignoredProperties - (optional) names of properties to ignore;
any fields that would be recognized as one of these properties
is ignored.forSerialization - If true, will collect serializable property
fields; if false, deserializablepublic Converter<java.lang.Object,java.lang.Object> _createConverter(java.lang.Object converterDef)