Module tools.jackson.databind
Package tools.jackson.databind

Class AnnotationIntrospector

java.lang.Object
tools.jackson.databind.AnnotationIntrospector
All Implemented Interfaces:
Serializable, tools.jackson.core.Versioned
Direct Known Subclasses:
AnnotationIntrospectorPair, JacksonAnnotationIntrospector, NopAnnotationIntrospector
public abstract class AnnotationIntrospector extends Object implements tools.jackson.core.Versioned, Serializable
Abstract class that defines API used for introspecting annotation-based configuration for serialization and deserialization. Separated so that different sets of annotations can be supported, and support plugged-in dynamically.

Although default implementations are based on using annotations as the only (or at least main) information source, custom implementations are not limited in such a way, and in fact there is no expectation they should be. So the name is bit of misnomer; this is a general configuration introspection facility.

NOTE: due to rapid addition of new methods (and changes to existing methods), it is strongly recommended that custom implementations should not directly extend this class, but rather extend NopAnnotationIntrospector. This way added methods will not break backwards compatibility of custom annotation introspectors.

See Also:

  • Constructor Details

    • AnnotationIntrospector

      public AnnotationIntrospector()

  • Method Details

    • nopInstance

      public static AnnotationIntrospector nopInstance()
      Factory method for accessing "no operation" implementation of introspector: instance that will never find any annotation-based configuration.
      Returns:
      "no operation" instance

    • pair

      public static AnnotationIntrospector pair(AnnotationIntrospector a1, AnnotationIntrospector a2)

    • allIntrospectors

      public Collection<AnnotationIntrospector> allIntrospectors()
      Method that can be used to collect all "real" introspectors that this introspector contains, if any; or this introspector if it is not a container. Used to get access to all container introspectors in their priority order.

      Default implementation returns a Singleton list with this introspector as contents. This usually works for sub-classes, except for proxy or delegating "container introspectors" which need to override implementation.

      Returns:
      Collection of all introspectors starting with this one, in case multiple introspectors are chained

    • allIntrospectors

      public Collection<AnnotationIntrospector> allIntrospectors(Collection<AnnotationIntrospector> result)
      Method that can be used to collect all "real" introspectors that this introspector contains, if any; or this introspector if it is not a container. Used to get access to all container introspectors in their priority order.

      Default implementation adds this introspector in result; this usually works for sub-classes, except for proxy or delegating "container introspectors" which need to override implementation.

      Parameters:
      result - Container to add introspectors to
      Returns:
      Passed in Collection filled with introspectors as explained above

    • version

      public abstract tools.jackson.core.Version version()
      Specified by:
      version in interface tools.jackson.core.Versioned

    • isAnnotationBundle

      public boolean isAnnotationBundle(Annotation ann)
      Method for checking whether given annotation is considered an annotation bundle: if so, all meta-annotations it has will be used instead of annotation ("bundle") itself.
      Parameters:
      ann - Annotated entity to introspect
      Returns:
      True if given annotation is considered an annotation bundle; false if not

    • findObjectIdInfo

      public ObjectIdInfo findObjectIdInfo(MapperConfig<?> config, Annotated ann)
      Method for checking whether given annotated thing (type, or accessor) indicates that values referenced (values of type of annotated class, or values referenced by annotated property; latter having precedence) should include Object Identifier, and if so, specify details of Object Identity used.
      Parameters:
      config - Effective mapper configuration in use
      ann - Annotated entity to introspect
      Returns:
      Details of Object Id as explained above, if Object Id handling to be applied; null otherwise.

    • findObjectReferenceInfo

      public ObjectIdInfo findObjectReferenceInfo(MapperConfig<?> config, Annotated ann, ObjectIdInfo objectIdInfo)
      Method for figuring out additional properties of an Object Identity reference
      Parameters:
      config - Effective mapper configuration in use
      ann - Annotated entity to introspect
      objectIdInfo - (optional) Base Object Id information, if any; null if none
      Returns:
      ObjectIdInfo augmented with possible additional information

    • findRootName

      public PropertyName 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. Returns null if no declaration found; can return explicit empty String, which is usually ignored as well as null.
      Parameters:
      config - Effective mapper configuration in use
      ac - Annotated class to introspect

    • isIgnorableType

      public Boolean 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.
      Parameters:
      config - Effective mapper configuration in use
      ac - Annotated class to introspect
      Returns:
      Boolean.TRUE if properties of type should be ignored; Boolean.FALSE if they are not to be ignored, null for default handling (which is 'do not ignore')

    • findPropertyIgnoralByName

      public JsonIgnoreProperties.Value findPropertyIgnoralByName(MapperConfig<?> config, Annotated ann)
      Method for finding information about properties to ignore either by name, or by more general specification ("ignore all unknown"). This method combines multiple aspects of name-based (as opposed to value-based) ignorals.
      Parameters:
      config - Configuration settings in effect (for serialization or deserialization)
      ann - Annotated entity (Class, Accessor) to introspect

    • findPropertyInclusionByName

      public JsonIncludeProperties.Value findPropertyInclusionByName(MapperConfig<?> config, Annotated ann)
      Method for finding information about names of properties to included. This is typically used to strictly limit properties to include based on fully defined set of names ("allow-listing"), as opposed to excluding potential properties by exclusion ("deny-listing").
      Parameters:
      config - Configuration settings in effect (for serialization or deserialization)
      ann - Annotated entity (Class, Accessor) to introspect

    • findFilterId

      public Object findFilterId(MapperConfig<?> config, Annotated ann)
      Method for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.
      Parameters:
      config - Effective mapper configuration in use
      ann - Annotated entity to introspect
      Returns:
      Id of the filter to use for filtering properties of annotated class, if any; or null if none found.

    • findNamingStrategy

      public Object findNamingStrategy(MapperConfig<?> config, AnnotatedClass ac)
      Method for finding PropertyNamingStrategy for given class, if any specified by annotations; and if so, either return a PropertyNamingStrategy instance, or Class to use for creating instance
      Parameters:
      config - Effective mapper configuration in use
      ac - Annotated class to introspect
      Returns:
      Sub-class or instance of PropertyNamingStrategy, if one is specified for given class; null if not.

    • findEnumNamingStrategy

      public Object findEnumNamingStrategy(MapperConfig<?> config, AnnotatedClass ac)
      Method for finding EnumNamingStrategy for given class, if any specified by annotations; and if so, either return a EnumNamingStrategy instance, or Class to use for creating instance
      Parameters:
      ac - Annotated class to introspect
      Returns:
      Subclass or instance of EnumNamingStrategy, if one is specified for given class; null if not.

    • findClassDescription

      public String findClassDescription(MapperConfig<?> config, AnnotatedClass ac)
      Method used to check whether specified class defines a human-readable description to use for documentation. There are no further definitions for contents; for example, whether these may be marked up using HTML (or something like wiki format like Markup) is not defined.
      Parameters:
      config - Effective mapper configuration in use
      ac - Annotated class to introspect
      Returns:
      Human-readable description, if any.

    • findAutoDetectVisibility

      public VisibilityChecker 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). A baseline checker is given, and introspector is to either return it as is (if no annotations are found), or build and return a derived instance (using checker's build methods).
      Parameters:
      config - Effective mapper configuration in use
      ac - Annotated class to introspect

    • findPolymorphicTypeInfo

      public JsonTypeInfo.Value findPolymorphicTypeInfo(MapperConfig<?> config, Annotated ann)
      Method for checking whether given Class or Property Accessor specifies polymorphic type-handling information, to indicate need for polymorphic handling.
      Parameters:
      config - Effective mapper configuration in use
      ann - Annotated entity to introspect
      Since:
      3.0

    • findTypeResolverBuilder

      public Object findTypeResolverBuilder(MapperConfig<?> config, Annotated ann)
      Parameters:
      config - Effective mapper configuration in use
      ann - Annotated entity to introspect
      Since:
      3.0

    • findTypeIdResolver

      public Object findTypeIdResolver(MapperConfig<?> config, Annotated ann)
      Parameters:
      config - Effective mapper configuration in use
      ann - Annotated entity to introspect
      Since:
      3.0

    • findSubtypes

      public List<NamedType> findSubtypes(MapperConfig<?> config, Annotated a)
      Method for locating annotation-specified subtypes related to annotated entity (class, method, field). Note that this is only guaranteed to be a list of directly declared subtypes, no recursive processing is guarantees (i.e. caller has to do it if/as necessary)
      Parameters:
      config - Effective mapper configuration in use
      a - Annotated entity (class, field/method) to check for annotations

    • findTypeName

      public String findTypeName(MapperConfig<?> config, AnnotatedClass ac)
      Method for checking if specified type has explicit name.
      Parameters:
      config - Effective mapper configuration in use
      ac - Class to check for type name annotations

    • isTypeId

      public Boolean isTypeId(MapperConfig<?> config, AnnotatedMember member)
      Method for checking whether given accessor claims to represent type id: if so, its value may be used as an override, instead of generated type id.
      Parameters:
      config - Effective mapper configuration in use
      member - Member to check for type id information

    • findReferenceType

      public AnnotationIntrospector.ReferenceProperty findReferenceType(MapperConfig<?> config, AnnotatedMember member)
      Method for checking if given member indicates that it is part of a reference (parent/child).
      Parameters:
      config - Effective mapper configuration in use
      member - Member to check for information

    • findUnwrappingNameTransformer

      public NameTransformer findUnwrappingNameTransformer(MapperConfig<?> config, AnnotatedMember member)
      Method called to check whether given property is marked to be "unwrapped" when being serialized (and appropriately handled in reverse direction, i.e. expect unwrapped representation during deserialization). Return value is the name transformation to use, if wrapping/unwrapping should be done, or null if not -- note that transformation may simply be identity transformation (no changes).
      Parameters:
      config - Effective mapper configuration in use
      member - Member to check for information

    • hasIgnoreMarker

      public boolean hasIgnoreMarker(MapperConfig<?> config, AnnotatedMember member)
      Method called to check whether given property is marked to be ignored. This is used to determine whether to ignore properties, on per-property basis, usually combining annotations from multiple accessors (getters, setters, fields, constructor parameters).
      Parameters:
      config - Effective mapper configuration in use
      member - Member to check for information

    • findInjectableValue

      public JacksonInject.Value findInjectableValue(MapperConfig<?> config, AnnotatedMember member)
      Method called to find out whether given member expectes a value to be injected, and if so, what is the identifier of the value to use during injection. Type if identifier needs to be compatible with provider of values (of type InjectableValues); often a simple String id is used.
      Parameters:
      config - Effective mapper configuration in use
      member - Member to check for information
      Returns:
      Identifier of value to inject, if any; null if no injection indicator is found

    • hasRequiredMarker

      public Boolean hasRequiredMarker(MapperConfig<?> config, AnnotatedMember member)
      Method that can be called to check whether this member has an annotation that suggests whether value for matching property is required or not.
      Parameters:
      config - Effective mapper configuration in use
      member - Member to check for information

    • findViews

      public Class<?>[] findViews(MapperConfig<?> config, Annotated a)
      Method for checking if annotated property (represented by a field or getter/setter method) has definitions for views it is to be included in. If null is returned, no view definitions exist and property is always included (or always excluded as per default view inclusion configuration); otherwise it will only be included for views included in returned array. View matches are checked using class inheritance rules (sub-classes inherit inclusions of super-classes)

      Since 2.9 this method may also be called to find "default view(s)" for AnnotatedClass

      Parameters:
      config - Effective mapper configuration in use
      a - Annotated property (represented by a method, field or ctor parameter)
      Returns:
      Array of views (represented by classes) that the property is included in; if null, always included (same as returning array containing Object.class)

    • findFormat

      public JsonFormat.Value findFormat(MapperConfig<?> config, Annotated memberOrClass)
      Method for finding format annotations for property or class. Return value is typically used by serializers and/or deserializers to customize presentation aspects of the serialized value.
      Parameters:
      config - Effective mapper configuration in use

    • findWrapperName

      public PropertyName findWrapperName(MapperConfig<?> config, Annotated ann)
      Method used to check if specified property has annotation that indicates that it should be wrapped in an element; and if so, name to use. Note that not all serializers and deserializers support use this method: currently (3.0) it is only used by XML-backed handlers.
      Parameters:
      config - Effective mapper configuration in use
      Returns:
      Wrapper name to use, if any, or PropertyName.USE_DEFAULT to indicate that no wrapper element should be used.

    • findPropertyDefaultValue

      public String findPropertyDefaultValue(MapperConfig<?> config, Annotated ann)
      Method for finding suggested default value (as simple textual serialization) for the property. While core databind does not make any use of it, it is exposed for extension modules to use: an expected use is generation of schema representations and documentation.
      Parameters:
      config - Effective mapper configuration in use

    • findPropertyDescription

      public String findPropertyDescription(MapperConfig<?> config, Annotated ann)
      Method used to check whether specified property member (accessor or mutator) defines human-readable description to use for documentation. There are no further definitions for contents; for example, whether these may be marked up using HTML is not defined.
      Parameters:
      config - Effective mapper configuration in use
      Returns:
      Human-readable description, if any.

    • findPropertyIndex

      public Integer findPropertyIndex(MapperConfig<?> config, Annotated ann)
      Method used to check whether specified property member (accessor or mutator) defines numeric index, and if so, what is the index value. Possible use cases for index values included use by underlying data format (some binary formats mandate use of index instead of name) and ordering of properties (for documentation, or during serialization).
      Parameters:
      config - Effective mapper configuration in use
      Returns:
      Explicitly specified index for the property, if any

    • findImplicitPropertyName

      public String findImplicitPropertyName(MapperConfig<?> config, AnnotatedMember member)
      Method for finding implicit name for a property that given annotated member (field, method, creator parameter) may represent. This is different from explicit, annotation-based property name, in that it is "weak" and does not either prove that a property exists (for example, if visibility is not high enough), or override explicit names. In practice this method is used to introspect optional names for creator parameters (which may or may not be available and cannot be detected by standard databind); or to provide alternate name mangling for fields, getters and/or setters.
      Parameters:
      config - Effective mapper configuration in use

    • findPropertyAliases

      public List<PropertyName> findPropertyAliases(MapperConfig<?> config, Annotated ann)
      Method called to find if given property has alias(es) defined.
      Parameters:
      config - Effective mapper configuration in use
      Returns:
      `null` if member has no information; otherwise a `List` (possibly empty) of aliases to use.

    • findPropertyAccess

      public JsonProperty.Access findPropertyAccess(MapperConfig<?> config, Annotated ann)
      Method for finding optional access definition for a property, annotated on one of its accessors. If a definition for read-only, write-only or read-write cases, visibility rules may be modified. Note, however, that even more specific annotations (like one for ignoring specific accessor) may further override behavior of the access definition.
      Parameters:
      config - Effective mapper configuration in use

    • resolveSetterConflict

      public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config, AnnotatedMethod setter1, AnnotatedMethod setter2)
      Method called in cases where a class has two methods eligible to be used for the same logical property, and default logic is not enough to figure out clear precedence. Introspector may try to choose one to use; or, if unable, return `null` to indicate it cannot resolve the problem.
      Parameters:
      config - Effective mapper configuration in use

    • findRenameByField

      public PropertyName findRenameByField(MapperConfig<?> config, AnnotatedField f, PropertyName implName)
      Method called on fields that are eligible candidates for properties (that is, non-static member fields), but not necessarily selected (may or may not be visible), to let fields affect name linking. Call will be made after finding implicit name (which by default is just name of the field, but may be overridden by introspector), but before discovering other accessors. If non-null name returned, it is to be used to find other accessors (getters, setters, creator parameters) and replace their implicit names with that of field's implicit name (assuming they differ).

      Specific example (and initial use case is for support Kotlin's "is getter" matching (see Kotling Interop for details), in which field like 'isOpen' would have implicit name of "isOpen", match getter getOpen() and setter setOpen(boolean), but use logical external name of "isOpen" (and not implicit name of getter/setter, "open"!). To achieve this, field implicit name needs to remain "isOpen" but this method needs to return name PropertyName.construct("open"): doing so will "pull in" getter and/or setter, and rename them as "isOpen".

      Parameters:
      config - Effective mapper configuration in use
      f - Field to check
      implName - Implicit name of the field; usually name of field itself but not always, used as the target name for accessors to rename.
      Returns:
      Name used to find other accessors to rename, if any; null to indicate no renaming

    • findSerializer

      public Object findSerializer(MapperConfig<?> config, Annotated am)
      Method for getting a serializer definition on specified method or field. Type of definition is either instance (of type ValueSerializer) or Class (of Class<ValueSerializer> implementation subtype); if value of different type is returned, a runtime exception may be thrown by caller.

    • findKeySerializer

      public Object findKeySerializer(MapperConfig<?> config, Annotated am)
      Method for getting a serializer definition for keys of associated java.util.Map property. Type of definition is either instance (of type ValueSerializer) or Class (of type Class<ValueSerializer>); if value of different type is returned, a runtime exception may be thrown by caller.

    • findContentSerializer

      public Object findContentSerializer(MapperConfig<?> config, Annotated am)
      Method for getting a serializer definition for content (values) of associated Collection, array or Map property. Type of definition is either instance (of type ValueSerializer) or Class (of type Class<ValueSerializer>); if value of different type is returned, a runtime exception may be thrown by caller.

    • findNullSerializer

      public Object findNullSerializer(MapperConfig<?> config, Annotated am)
      Method for getting a serializer definition for serializer to use for nulls (null values) of associated property or type.

    • findSerializationTyping

      public JsonSerialize.Typing findSerializationTyping(MapperConfig<?> config, Annotated a)
      Method for accessing declared typing mode annotated (if any). This is used for type detection, unless more granular settings (such as actual exact type; or serializer to use which means no type information is needed) take precedence.
      Returns:
      Typing mode to use, if annotation is found; null otherwise

    • findSerializationConverter

      public Object findSerializationConverter(MapperConfig<?> config, Annotated a)
      Method for finding Converter that annotated entity (property or class) has indicated to be used as part of serialization. If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used first to convert property value to converter target type, and then serializer for that type is used for actual serialization.

      This feature is typically used to convert internal values into types that Jackson can convert.

      Note also that this feature does not necessarily work well with polymorphic type handling, or object identity handling; if such features are needed an explicit serializer is usually better way to handle serialization.

      Parameters:
      a - Annotated property (field, method) or class to check for annotations

    • findSerializationContentConverter

      public Object findSerializationContentConverter(MapperConfig<?> config, AnnotatedMember a)
      Method for finding Converter that annotated property has indicated needs to be used for values of container type (this also means that method should only be called for properties of container types, List/Map/array properties).

      If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used first to convert property value to converter target type, and then serializer for that type is used for actual serialization.

      Other notes are same as those for findSerializationConverter(tools.jackson.databind.cfg.MapperConfig<?>, tools.jackson.databind.introspect.Annotated)

      Parameters:
      a - Annotated property (field, method) to check.

    • findPropertyInclusion

      public JsonInclude.Value findPropertyInclusion(MapperConfig<?> config, Annotated a)
      Method for checking inclusion criteria for a type (Class) or property (yes, method name is bit unfortunate -- not just for properties!). In case of class, acts as the default for properties POJO contains; for properties acts as override for class defaults and possible global defaults.

    • refineSerializationType

      public JavaType refineSerializationType(MapperConfig<?> config, Annotated a, JavaType baseType)
      Method called to find out possible type refinements to use for deserialization, including not just value itself but key and/or content type, if type has those.

    • findSerializationPropertyOrder

      public String[] findSerializationPropertyOrder(MapperConfig<?> config, AnnotatedClass ac)
      Method for accessing defined property serialization order (which may be partial). May return null if no ordering is defined.

    • findSerializationSortAlphabetically

      public Boolean findSerializationSortAlphabetically(MapperConfig<?> config, Annotated ann)
      Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered

    • findAndAddVirtualProperties

      public void findAndAddVirtualProperties(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties)
      Method for adding possible virtual properties to be serialized along with regular properties.

    • findNameForSerialization

      public PropertyName findNameForSerialization(MapperConfig<?> config, Annotated a)
      Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for serialization. Should return null if no annotation is found; otherwise a non-null name (possibly PropertyName.USE_DEFAULT, which means "use default heuristics").
      Parameters:
      a - Property accessor to check
      Returns:
      Name to use if found; null if not.

    • hasAsKey

      public Boolean hasAsKey(MapperConfig<?> config, Annotated a)
      Method for checking whether given method has an annotation that suggests the return value of annotated field or method should be used as "the key" of the object instance; usually serialized as a primitive value such as String or number.
      Returns:
      Boolean.TRUE if such annotation is found and is not disabled; Boolean.FALSE if disabled annotation (block) is found (to indicate accessor is definitely NOT to be used "as value"); or `null` if no information found.

    • hasAsValue

      public Boolean hasAsValue(MapperConfig<?> config, Annotated a)
      Method for checking whether given method has an annotation that suggests that the return value of annotated method should be used as "the value" of the object instance; usually serialized as a primitive value such as String or number.
      Returns:
      Boolean.TRUE if such annotation is found and is not disabled; Boolean.FALSE if disabled annotation (block) is found (to indicate accessor is definitely NOT to be used "as value"); or `null` if no information found.

    • hasAnyGetter

      public Boolean hasAnyGetter(MapperConfig<?> config, Annotated ann)
      Method for checking whether given method has an annotation that suggests that the method is to serve as "any setter"; method to be used for accessing set of miscellaneous "extra" properties, often bound with matching "any setter" method.
      Parameters:
      ann - Annotated entity to check
      Returns:
      True if such annotation is found (and is not disabled), false otherwise

    • findEnumValues

      public String[] findEnumValues(MapperConfig<?> config, AnnotatedClass annotatedClass, Enum<?>[] enumValues, String[] names)
      Finds the explicitly defined name of the given set of Enum values, if any. The method overwrites entries in the incoming names array with the explicit names found, if any, leaving other entries unmodified.
      Parameters:
      config - the mapper configuration to use
      annotatedClass - the annotated class for which to find the explicit names
      enumValues - the set of Enum values to find the explicit names for
      names - the matching declared names of enumeration values (with indexes matching enumValues entries)
      Returns:
      an array of names to use (possibly names passed as argument)
      Since:
      2.16

    • findEnumAliases

      public void 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 to findEnumValues(tools.jackson.databind.cfg.MapperConfig<?>, tools.jackson.databind.introspect.AnnotatedClass, java.lang.Enum<?>[], java.lang.String[]). These aliases should be returned in String[][] aliases passed in as argument. The aliases.length is expected to match the number of Enum values.
      Parameters:
      config - The configuration of the mapper
      annotatedClass - The annotated class of the enumeration type
      enumValues - The values of the enumeration
      aliases - (in/out) Pre-allocated array where aliases found, if any, may be added (in indexes matching those of enumValues)
      Since:
      2.16

    • findDefaultEnumValue

      public Enum<?> 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.
      Parameters:
      ac - The Enum class to scan for the default value.
      enumValues - The Enum values of the Enum class.
      Returns:
      null if none found or it's not possible to determine one.
      Since:
      2.16

    • findDeserializer

      public Object findDeserializer(MapperConfig<?> config, Annotated am)
      Method for getting a deserializer definition on specified method or field. Type of definition is either instance (of type ValueDeserializer) or Class (of type Class&<ValueDeserializer>); type is returned, a runtime exception may be thrown by caller.

    • findKeyDeserializer

      public Object findKeyDeserializer(MapperConfig<?> config, Annotated am)
      Method for getting a deserializer definition for keys of associated Map property. Type of definition is either instance (of type ValueDeserializer) or Class (of type Class<ValueDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller.

    • findContentDeserializer

      public Object findContentDeserializer(MapperConfig<?> config, Annotated am)
      Method for getting a deserializer definition for content (values) of associated Collection, array or Map property. Type of definition is either instance (of type ValueDeserializer) or Class (of type Class<ValueDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller.

    • findDeserializationConverter

      public Object findDeserializationConverter(MapperConfig<?> config, Annotated a)
      Method for finding Converter that annotated entity (property or class) has indicated to be used as part of deserialization. If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used after Jackson has deserializer data into intermediate type (Converter input type), and Converter needs to convert this into its target type to be set as property value.

      This feature is typically used to convert intermediate Jackson types (that default deserializers can produce) into custom type instances.

      Note also that this feature does not necessarily work well with polymorphic type handling, or object identity handling; if such features are needed an explicit deserializer is usually better way to handle deserialization.

      Parameters:
      a - Annotated property (field, method) or class to check for annotations

    • findDeserializationContentConverter

      public Object findDeserializationContentConverter(MapperConfig<?> config, AnnotatedMember a)
      Method for finding Converter that annotated property has indicated needs to be used for values of container type (this also means that method should only be called for properties of container types, List/Map/array properties).

      If not null, either has to be actual Converter instance, or class for such converter; and resulting converter will be used after Jackson has deserializer data into intermediate type (Converter input type), and Converter needs to convert this into its target type to be set as property value.

      Other notes are same as those for findDeserializationConverter(tools.jackson.databind.cfg.MapperConfig<?>, tools.jackson.databind.introspect.Annotated)

      Parameters:
      a - Annotated property (field, method) to check.

    • refineDeserializationType

      public JavaType refineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType)
      Method called to find out possible type refinements to use for deserialization.

    • findValueInstantiator

      public Object findValueInstantiator(MapperConfig<?> config, AnnotatedClass ac)
      Method getting ValueInstantiator to use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.
      Parameters:
      ac - Annotated class to introspect

    • findPOJOBuilder

      public Class<?> 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).

      Note that unlike accessors for some helper Objects, this method does not allow returning instances: the reason is that builders have state, and a separate instance needs to be created for each deserialization call.

      Parameters:
      ac - Annotated class to introspect

    • findPOJOBuilderConfig

      public JsonPOJOBuilder.Value findPOJOBuilderConfig(MapperConfig<?> config, AnnotatedClass ac)
      Parameters:
      ac - Annotated class to introspect

    • findCreatorAnnotation

      public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated a)
      Method called to check whether potential Creator (constructor or static factory method) has explicit annotation to indicate it as actual Creator; and if so, which JsonCreator.Mode to use.

      NOTE: caller needs to consider possibility of both `null` (no annotation found) and JsonCreator.Mode.DISABLED (annotation found, but disabled); latter is necessary as marker in case multiple introspectors are chained, as well as possibly as when using mix-in annotations.

      Parameters:
      config - Configuration settings in effect (for serialization or deserialization)
      a - Annotated accessor (usually constructor or static method) to check

    • findPreferredCreator

      public PotentialCreator 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 (findCreatorAnnotation(tools.jackson.databind.cfg.MapperConfig<?>, tools.jackson.databind.introspect.Annotated) returns null). Examples of preferred creators include the canonical constructor defined by Java Records; "Data" classes by frameworks like Lombok and JVM languages like Kotlin and Scala (case classes) also have similar concepts. If introspector can determine that one of given PotentialCreators should be considered preferred one, it should return it; if not, it should return null. Note that core databind functionality may call this method even in the presence of explicitly annotated creators; and may or may not use Creator returned depending on other criteria.

      NOTE: when returning chosen Creator, it may be necessary to mark its "mode" with PotentialCreator.overrideMode(com.fasterxml.jackson.annotation.JsonCreator.Mode) (especially for "delegating" creators).

      NOTE: method is NOT called for Java Record types; selection of the canonical constructor as the Primary creator is handled directly by POJOPropertiesCollector

      NOTE: was called findDefaultCreator() in Jackson 2.x but was renamed due to possible confusion with 0-argument "default" constructor.

      Parameters:
      config - Configuration settings in effect (for deserialization)
      valueClass - Class being instantiated; defines Creators passed
      declaredConstructors - Constructors value class declares
      declaredFactories - Factory methods value class declares
      Returns:
      Default Creator to possibly use for valueClass, if one can be determined; null if not.
      Since:
      2.18

    • findNameForDeserialization

      public PropertyName findNameForDeserialization(MapperConfig<?> config, Annotated ann)
      Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for deserialization (reading JSON into POJOs). Should return null if no annotation is found; otherwise a non-null name (possibly PropertyName.USE_DEFAULT, which means "use default heuristics").
      Parameters:
      ann - Annotated entity to check
      Returns:
      Name to use if found; null if not.

    • hasAnySetter

      public Boolean hasAnySetter(MapperConfig<?> config, Annotated ann)
      Method for checking whether given method has an annotation that suggests that the method is to serve as "any setter"; method to be used for setting values of any properties for which no dedicated setter method is found.
      Parameters:
      ann - Annotated entity to check
      Returns:
      True if such annotation is found (and is not disabled), false otherwise

    • findSetterInfo

      public JsonSetter.Value findSetterInfo(MapperConfig<?> config, Annotated a)
      Method for finding possible settings for property, given annotations on an accessor.

    • findMergeInfo

      public Boolean findMergeInfo(MapperConfig<?> config, Annotated a)
      Method for finding merge settings for property, if any.

    • _findAnnotation

      protected <A extends Annotation> A _findAnnotation(Annotated ann, Class<A> annoClass)
      Method that should be used by sub-classes for ALL annotation access; overridable so that sub-classes may, if they choose to, mangle actual access to block access ("hide" annotations) or perhaps change it.

      Default implementation is simply: return annotated.getAnnotation(annoClass);

      Parameters:
      ann - Annotated entity to check for specified annotation
      annoClass - Type of annotation to find
      Returns:
      Value of given annotation (as per annoClass), if entity has one; null otherwise

    • _hasAnnotation

      protected boolean _hasAnnotation(Annotated ann, Class<? extends Annotation> annoClass)
      Method that should be used by sub-classes for ALL annotation existence access; overridable so that sub-classes may, if they choose to, mangle actual access to block access ("hide" annotations) or perhaps change value seen.

      Default implementation is simply: return annotated.hasAnnotation(annoClass);

      Parameters:
      ann - Annotated entity to check for specified annotation
      annoClass - Type of annotation to find
      Returns:
      true if specified annotation exists in given entity; false if not

    • _hasOneOf

      protected boolean _hasOneOf(Annotated ann, Class<? extends Annotation>[] annoClasses)
      Alternative lookup method that is used to see if annotation has at least one of annotations of types listed in second argument.
      Parameters:
      ann - Annotated entity to check for specified annotation
      annoClasses - Types of annotation to find
      Returns:
      true if at least one of specified annotation exists in given entity; false otherwise