Uses of Class
tools.jackson.databind.introspect.AnnotatedClass
Packages that use AnnotatedClass
Package
Description
Basic data binding (mapping) functionality that
allows for reading JSON content into Java Objects (POJOs)
and JSON Trees (
JsonNode
), as well as
writing Java Objects and trees as JSON.Package that contains most of configuration-related classes;
exception being couple of most-commonly used configuration
things (like Feature enumerations) that are at the
main level (
tools.jackson.databind
).Contains implementation classes of deserialization part of
data binding.
Functionality needed for Bean introspection, required for detecting
accessors and mutators for Beans, as well as locating and handling
method annotations.
Package that contains interfaces that define how to implement
functionality for dynamically resolving type during deserialization.
Package that contains standard implementations for
TypeResolverBuilder
and
TypeIdResolver
.Contains implementation classes of serialization part of
data binding.
Contains implementation classes of serialization part of
data binding.
Utility classes for Mapper package.
-
Uses of AnnotatedClass in tools.jackson.databind
Methods in tools.jackson.databind that return AnnotatedClassModifier and TypeMethodDescriptionabstract AnnotatedClass
BeanDescription.getClassInfo()
Method for accessing low-level information about Class this item describes.DatabindContext.introspectClassAnnotations
(Class<?> rawType) DatabindContext.introspectClassAnnotations
(JavaType type) DatabindContext.introspectDirectClassAnnotations
(JavaType type) Methods in tools.jackson.databind with parameters of type AnnotatedClassModifier and TypeMethodDescriptionEnumNamingStrategies.DelegatingEnumNamingStrategy.convertEnumToExternalName
(MapperConfig<?> config, AnnotatedClass cls, String enumName) EnumNamingStrategy.convertEnumToExternalName
(MapperConfig<?> config, AnnotatedClass cls, String enumName) Translates the givenenumName
into an external property name according to the implementation of thisEnumNamingStrategy
.void
AnnotationIntrospector.findAndAddVirtualProperties
(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties) Method for adding possible virtual properties to be serialized along with regular properties.AnnotationIntrospector.findAutoDetectVisibility
(MapperConfig<?> config, AnnotatedClass ac, VisibilityChecker checker) Method for checking if annotations indicate changes to minimum visibility levels needed for auto-detecting property elements (fields, methods, constructors).AnnotationIntrospector.findClassDescription
(MapperConfig<?> config, AnnotatedClass ac) Method used to check whether specified class defines a human-readable description to use for documentation.Enum<?>
AnnotationIntrospector.findDefaultEnumValue
(MapperConfig<?> config, AnnotatedClass ac, Enum<?>[] enumValues) Finds the first Enum value that should be considered as default value for unknown Enum values, if present.void
AnnotationIntrospector.findEnumAliases
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues, String[][] aliases) Method that is called to check if there are alternative names (aliases) that can be accepted for entries in addition to primary names that were introspected earlier, related toAnnotationIntrospector.findEnumValues(tools.jackson.databind.cfg.MapperConfig<?>, tools.jackson.databind.introspect.AnnotatedClass, java.lang.Enum<?>[], java.lang.String[])
.AnnotationIntrospector.findEnumNamingStrategy
(MapperConfig<?> config, AnnotatedClass ac) Method for findingEnumNamingStrategy
for given class, if any specified by annotations; and if so, either return aEnumNamingStrategy
instance, or Class to use for creating instanceString[]
AnnotationIntrospector.findEnumValues
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues, String[] names) Finds the explicitly defined name of the given set ofEnum
values, if any.AnnotationIntrospector.findNamingStrategy
(MapperConfig<?> config, AnnotatedClass ac) Method for findingPropertyNamingStrategy
for given class, if any specified by annotations; and if so, either return aPropertyNamingStrategy
instance, or Class to use for creating instanceClass<?>
AnnotationIntrospector.findPOJOBuilder
(MapperConfig<?> config, AnnotatedClass ac) Method for finding Builder object to use for constructing value instance and binding data (sort of combining value instantiators that can construct, and deserializers that can bind data).AnnotationIntrospector.findPOJOBuilderConfig
(MapperConfig<?> config, AnnotatedClass ac) AnnotationIntrospector.findPreferredCreator
(MapperConfig<?> config, AnnotatedClass valueClass, List<PotentialCreator> declaredConstructors, List<PotentialCreator> declaredFactories) Method called to check if introspector can find a Creator it considers its "Preferred Creator": Creator to use as the primary one, when no Creator has explicit annotation (AnnotationIntrospector.findCreatorAnnotation(tools.jackson.databind.cfg.MapperConfig<?>, tools.jackson.databind.introspect.Annotated)
returnsnull
).AnnotationIntrospector.findRootName
(MapperConfig<?> config, AnnotatedClass ac) Method for locating name used as "root name" (for use by some serializers when outputting root-level object -- mostly for XML compatibility purposes) for given class, if one is defined.String[]
AnnotationIntrospector.findSerializationPropertyOrder
(MapperConfig<?> config, AnnotatedClass ac) Method for accessing defined property serialization order (which may be partial).DeserializationContext.findTypeDeserializer
(JavaType baseType, AnnotatedClass classAnnotations) AnnotationIntrospector.findTypeName
(MapperConfig<?> config, AnnotatedClass ac) Method for checking if specified type has explicit name.SerializationContext.findTypeSerializer
(JavaType baseType, AnnotatedClass classAnnotations) Method called to get theTypeSerializer
to use for including Type Id necessary for serializing for the given Java class.AnnotationIntrospector.findValueInstantiator
(MapperConfig<?> config, AnnotatedClass ac) Method gettingValueInstantiator
to use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.AnnotationIntrospector.isIgnorableType
(MapperConfig<?> config, AnnotatedClass ac) Method for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes. -
Uses of AnnotatedClass in tools.jackson.databind.cfg
Methods in tools.jackson.databind.cfg with parameters of type AnnotatedClassModifier and TypeMethodDescriptionabstract JsonIgnoreProperties.Value
MapperConfig.getDefaultPropertyIgnorals
(Class<?> baseType, AnnotatedClass actualClass) Helper method that may be called to see if there are property ignoral definitions from annotations (viaAnnotatedClass
) or through "config overrides".MapperConfigBase.getDefaultPropertyIgnorals
(Class<?> baseType, AnnotatedClass actualClass) abstract JsonIncludeProperties.Value
MapperConfig.getDefaultPropertyInclusions
(Class<?> baseType, AnnotatedClass actualClass) Helper method that may be called to see if there are property inclusion definitions from annotations (viaAnnotatedClass
).MapperConfigBase.getDefaultPropertyInclusions
(Class<?> baseType, AnnotatedClass actualClass) abstract VisibilityChecker
MapperConfig.getDefaultVisibilityChecker
(Class<?> baseType, AnnotatedClass actualClass) Accessor for object used for determining whether specific property elements (method, constructors, fields) can be auto-detected based on their visibility (access modifiers).final VisibilityChecker
MapperConfigBase.getDefaultVisibilityChecker
(Class<?> baseType, AnnotatedClass actualClass) -
Uses of AnnotatedClass in tools.jackson.databind.deser
Methods in tools.jackson.databind.deser with parameters of type AnnotatedClassModifier and TypeMethodDescriptionprotected EnumResolver
BasicDeserializerFactory.constructEnumNamingStrategyResolver
(DeserializationConfig config, AnnotatedClass enumClass) Factory method used to resolve an instance ofCompactStringObjectMap
withEnumNamingStrategy
applied for the target class. -
Uses of AnnotatedClass in tools.jackson.databind.introspect
Fields in tools.jackson.databind.introspect declared as AnnotatedClassModifier and TypeFieldDescriptionprotected final AnnotatedClass
POJOPropertiesCollector._classDef
Low-level introspected class information (methods, fields etc)protected final AnnotatedClass
BasicBeanDescription._classInfo
Information collected about the class introspected.protected final AnnotatedClass
DefaultAccessorNamingStrategy._forClass
Fields in tools.jackson.databind.introspect with type parameters of type AnnotatedClassModifier and TypeFieldDescriptionprotected HashMap<JavaType,
AnnotatedClass> BasicClassIntrospector._resolvedFullAnnotations
Reuse fully-resolved annotations during a single operationMethods in tools.jackson.databind.introspect that return AnnotatedClassModifier and TypeMethodDescriptionprotected AnnotatedClass
BasicClassIntrospector._findStdTypeDef
(JavaType type) Method called to see if type is one of core JDK types that we have cached for efficiency.protected AnnotatedClass
BasicClassIntrospector._resolveAnnotatedClass
(JavaType type) protected AnnotatedClass
BasicClassIntrospector._resolveAnnotatedWithoutSuperTypes
(JavaType type) POJOPropertiesCollector.getClassDef()
BasicBeanDescription.getClassInfo()
BasicClassIntrospector.introspectClassAnnotations
(JavaType type) abstract AnnotatedClass
ClassIntrospector.introspectClassAnnotations
(JavaType type) Factory method that constructs an introspector that only has information regarding annotations class itself (or its supertypes) has, but nothing on methods or constructors.BasicClassIntrospector.introspectDirectClassAnnotations
(JavaType type) abstract AnnotatedClass
ClassIntrospector.introspectDirectClassAnnotations
(JavaType type) Factory method that constructs an introspector that only has information regarding annotations class itself has (but NOT including its supertypes), but nothing on methods or constructors.static AnnotatedClass
AnnotatedClassResolver.resolve
(MapperConfig<?> config, JavaType forType, MixInResolver r) static AnnotatedClass
AnnotatedClassResolver.resolveWithoutSuperTypes
(MapperConfig<?> config, Class<?> forType) static AnnotatedClass
AnnotatedClassResolver.resolveWithoutSuperTypes
(MapperConfig<?> config, Class<?> forType, MixInResolver r) static AnnotatedClass
AnnotatedClassResolver.resolveWithoutSuperTypes
(MapperConfig<?> config, JavaType forType, MixInResolver r) Methods in tools.jackson.databind.introspect with parameters of type AnnotatedClassModifier and TypeMethodDescriptionprotected BeanPropertyWriter
JacksonAnnotationIntrospector._constructVirtualProperty
(JsonAppend.Attr attr, MapperConfig<?> config, AnnotatedClass ac, JavaType type) protected BeanPropertyWriter
JacksonAnnotationIntrospector._constructVirtualProperty
(JsonAppend.Prop prop, MapperConfig<?> config, AnnotatedClass ac) protected POJOPropertiesCollector
BasicClassIntrospector.collectProperties
(JavaType type, AnnotatedClass classDef, boolean forSerialization, String mutatorPrefix) protected POJOPropertiesCollector
BasicClassIntrospector.collectPropertiesWithBuilder
(JavaType type, AnnotatedClass builderClassDef, BeanDescription valueTypeDesc, boolean forSerialization) protected POJOPropertiesCollector
BasicClassIntrospector.constructPropertyCollector
(JavaType type, AnnotatedClass classDef, boolean forSerialization, AccessorNamingStrategy accNaming) Overridable method called for creatingPOJOPropertiesCollector
instance to use; override is needed if a custom sub-class is to be used.void
AnnotationIntrospectorPair.findAndAddVirtualProperties
(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties) void
JacksonAnnotationIntrospector.findAndAddVirtualProperties
(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties) AnnotationIntrospectorPair.findAutoDetectVisibility
(MapperConfig<?> config, AnnotatedClass ac, VisibilityChecker checker) JacksonAnnotationIntrospector.findAutoDetectVisibility
(MapperConfig<?> config, AnnotatedClass ac, VisibilityChecker checker) AnnotationIntrospectorPair.findClassDescription
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findClassDescription
(MapperConfig<?> config, AnnotatedClass ac) Enum<?>
AnnotationIntrospectorPair.findDefaultEnumValue
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues) Enum<?>
JacksonAnnotationIntrospector.findDefaultEnumValue
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues) Finds the Enum value that should be considered the default value, if possible.void
AnnotationIntrospectorPair.findEnumAliases
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumConstants, String[][] aliases) void
JacksonAnnotationIntrospector.findEnumAliases
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues, String[][] aliasList) AnnotationIntrospectorPair.findEnumNamingStrategy
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findEnumNamingStrategy
(MapperConfig<?> config, AnnotatedClass ac) String[]
AnnotationIntrospectorPair.findEnumValues
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues, String[] names) String[]
JacksonAnnotationIntrospector.findEnumValues
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues, String[] names) AnnotationIntrospectorPair.findNamingStrategy
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findNamingStrategy
(MapperConfig<?> config, AnnotatedClass ac) Class<?>
AnnotationIntrospectorPair.findPOJOBuilder
(MapperConfig<?> config, AnnotatedClass ac) Class<?>
JacksonAnnotationIntrospector.findPOJOBuilder
(MapperConfig<?> config, AnnotatedClass ac) AnnotationIntrospectorPair.findPOJOBuilderConfig
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findPOJOBuilderConfig
(MapperConfig<?> config, AnnotatedClass ac) AnnotationIntrospectorPair.findPreferredCreator
(MapperConfig<?> config, AnnotatedClass valueClass, List<PotentialCreator> declaredConstructors, List<PotentialCreator> declaredFactories) AnnotationIntrospectorPair.findRootName
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findRootName
(MapperConfig<?> config, AnnotatedClass ac) String[]
AnnotationIntrospectorPair.findSerializationPropertyOrder
(MapperConfig<?> config, AnnotatedClass ac) String[]
JacksonAnnotationIntrospector.findSerializationPropertyOrder
(MapperConfig<?> config, AnnotatedClass ac) AnnotationIntrospectorPair.findTypeName
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findTypeName
(MapperConfig<?> config, AnnotatedClass ac) AnnotationIntrospectorPair.findValueInstantiator
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.findValueInstantiator
(MapperConfig<?> config, AnnotatedClass ac) abstract AccessorNamingStrategy
AccessorNamingStrategy.Provider.forBuilder
(MapperConfig<?> config, AnnotatedClass builderClass, BeanDescription valueTypeDesc) Factory method for creating strategy instance for POJOs that are deserialized using Builder type: in this case eventual target (value) type is different from type of "builder" object that is used by databinding to accumulate state.DefaultAccessorNamingStrategy.Provider.forBuilder
(MapperConfig<?> config, AnnotatedClass builderClass, BeanDescription valueTypeDesc) static BasicBeanDescription
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.abstract AccessorNamingStrategy
AccessorNamingStrategy.Provider.forPOJO
(MapperConfig<?> config, AnnotatedClass valueClass) Factory method for creating strategy instance for a "regular" POJO, called if none of the other factory methods is applicable.DefaultAccessorNamingStrategy.Provider.forPOJO
(MapperConfig<?> config, AnnotatedClass targetClass) abstract AccessorNamingStrategy
AccessorNamingStrategy.Provider.forRecord
(MapperConfig<?> config, AnnotatedClass recordClass) Factory method for creating strategy instance for specialjava.lang.Record
type (new in JDK 14).DefaultAccessorNamingStrategy.Provider.forRecord
(MapperConfig<?> config, AnnotatedClass recordClass) AnnotationIntrospectorPair.isIgnorableType
(MapperConfig<?> config, AnnotatedClass ac) JacksonAnnotationIntrospector.isIgnorableType
(MapperConfig<?> config, AnnotatedClass ac) Constructors in tools.jackson.databind.introspect with parameters of type AnnotatedClassModifierConstructorDescriptionprotected
BasicBeanDescription
(MapperConfig<?> config, JavaType type, AnnotatedClass classDef) Alternate constructor used in cases where property information is not needed, only class info.protected
BasicBeanDescription
(POJOPropertiesCollector coll, JavaType type, AnnotatedClass classDef) protected
DefaultAccessorNamingStrategy
(MapperConfig<?> config, AnnotatedClass forClass, String mutatorPrefix, String getterPrefix, String isGetterPrefix, DefaultAccessorNamingStrategy.BaseNameValidator baseNameValidator) protected
POJOPropertiesCollector
(MapperConfig<?> config, boolean forSerialization, JavaType type, AnnotatedClass classDef, AccessorNamingStrategy accessorNaming) RecordNaming
(MapperConfig<?> config, AnnotatedClass forClass) -
Uses of AnnotatedClass in tools.jackson.databind.jsontype
Methods in tools.jackson.databind.jsontype with parameters of type AnnotatedClassModifier and TypeMethodDescriptionabstract Collection<NamedType>
SubtypeResolver.collectAndResolveSubtypesByClass
(MapperConfig<?> config, AnnotatedClass baseType) Method for finding out all reachable subtypes for given type, such that access is by type, typically needed for serialization (converting from type to type name).abstract Collection<NamedType>
SubtypeResolver.collectAndResolveSubtypesByTypeId
(MapperConfig<?> config, AnnotatedClass baseType) Method for finding out all reachable subtypes for given type, such that access is by type id, typically needed for deserialization (converting from type id to type).TypeResolverProvider.findTypeDeserializer
(DeserializationContext ctxt, JavaType baseType, AnnotatedClass classInfo) TypeResolverProvider.findTypeSerializer
(SerializationContext ctxt, JavaType baseType, AnnotatedClass classInfo) Method for checking if given class has annotations that indicate that specific type resolver is to be used for handling instances of given type. -
Uses of AnnotatedClass in tools.jackson.databind.jsontype.impl
Methods in tools.jackson.databind.jsontype.impl with parameters of type AnnotatedClassModifier and TypeMethodDescriptionprotected void
StdSubtypeResolver._collectAndResolve
(MapperConfig<?> config, AnnotatedClass annotatedType, NamedType namedType, AnnotationIntrospector ai, HashMap<NamedType, NamedType> collectedSubtypes) Method called to find subtypes for a specific type (class), using type (class) as the unique key (in case of conflicts).protected void
StdSubtypeResolver._collectAndResolveByTypeId
(MapperConfig<?> config, AnnotatedClass annotatedType, NamedType namedType, Set<Class<?>> typesHandled, Map<String, NamedType> byName) Method called to find subtypes for a specific type (class), using type id as the unique key (in case of conflicts).StdSubtypeResolver.collectAndResolveSubtypesByClass
(MapperConfig<?> config, AnnotatedClass type) StdSubtypeResolver.collectAndResolveSubtypesByTypeId
(MapperConfig<?> config, AnnotatedClass baseType) -
Uses of AnnotatedClass in tools.jackson.databind.ser
Methods in tools.jackson.databind.ser that return AnnotatedClassMethods in tools.jackson.databind.ser with parameters of type AnnotatedClassModifier and TypeMethodDescriptionabstract VirtualBeanPropertyWriter
VirtualBeanPropertyWriter.withConfig
(MapperConfig<?> config, AnnotatedClass declaringClass, BeanPropertyDefinition propDef, JavaType type) Contextualization method called on a newly constructed virtual bean property. -
Uses of AnnotatedClass in tools.jackson.databind.ser.impl
Methods in tools.jackson.databind.ser.impl with parameters of type AnnotatedClassModifier and TypeMethodDescriptionAttributePropertyWriter.withConfig
(MapperConfig<?> config, AnnotatedClass declaringClass, BeanPropertyDefinition propDef, JavaType type) Since this method should typically not be called on this sub-type, default implementation simply throws anIllegalStateException
. -
Uses of AnnotatedClass in tools.jackson.databind.ser.jdk
Methods in tools.jackson.databind.ser.jdk with parameters of type AnnotatedClassModifier and TypeMethodDescriptionprotected static EnumValues
EnumSerializer.constructEnumNamingStrategyValues
(SerializationConfig config, Class<Enum<?>> enumClass, AnnotatedClass annotatedClass) Factory method used to resolve an instance ofEnumValues
withEnumNamingStrategy
applied for the target class.static ValueSerializer<Object>
JDKKeySerializers.getFallbackKeySerializer
(SerializationConfig config, Class<?> rawKeyType, AnnotatedClass annotatedClass) Method called if no specified key serializer was located; will return a "default" key serializer initialized byJDKKeySerializers.EnumKeySerializer.construct(Class, EnumValues, EnumValues)
-
Uses of AnnotatedClass in tools.jackson.databind.util
Methods in tools.jackson.databind.util with parameters of type AnnotatedClassModifier and TypeMethodDescriptionprotected static Enum<?>
EnumResolver._enumDefault
(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enums) Internal helper method used to resolveJsonEnumDefaultValue
static EnumValues
EnumValues.construct
(SerializationConfig config, AnnotatedClass enumClass) NOTE: do NOT call this if configuration may change, and choice between toString() and name() might change dynamically.static EnumResolver
EnumResolver.constructFor
(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing anEnumResolver
based on the givenDeserializationConfig
andAnnotatedClass
of the enum to be resolved.static EnumValues
EnumValues.constructFromName
(MapperConfig<?> config, AnnotatedClass annotatedClass) static EnumValues
EnumValues.constructFromToString
(MapperConfig<?> config, AnnotatedClass annotatedClass) static EnumResolver
EnumResolver.constructUsingEnumNamingStrategy
(DeserializationConfig config, AnnotatedClass annotatedClass, EnumNamingStrategy enumNamingStrategy) Factory method for constructing anEnumResolver
withEnumNamingStrategy
applied.static EnumValues
EnumValues.constructUsingEnumNamingStrategy
(MapperConfig<?> config, AnnotatedClass annotatedClass, EnumNamingStrategy namingStrategy) Returns String serializations of Enum name using an instance ofEnumNamingStrategy
.static EnumResolver
EnumResolver.constructUsingIndex
(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing resolver that maps from index of Enum.values() into Enum value.static EnumResolver
EnumResolver.constructUsingMethod
(DeserializationConfig config, AnnotatedClass annotatedClass, AnnotatedMember accessor) Method used when actual String serialization is indicated using @JsonValue on a method in Enum class.static EnumResolver
EnumResolver.constructUsingToString
(DeserializationConfig config, AnnotatedClass annotatedClass) Factory method for constructing resolver that maps from Enum.toString() into Enum valuestatic PotentialCreator
RecordUtil.findCanonicalRecordConstructor
(MapperConfig<?> config, AnnotatedClass recordClass, List<PotentialCreator> constructors)