com.fasterxml.jackson.databind

Class AnnotationIntrospector

  • All Implemented Interfaces:
    Versioned
    Direct Known Subclasses:
    AnnotationIntrospectorPair, JacksonAnnotationIntrospector, NopAnnotationIntrospector

    public abstract class AnnotationIntrospector
extends Object
implements Versioned
    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.

    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.

    • Constructor Detail

      • AnnotationIntrospector

        public AnnotationIntrospector()

    • Method Detail

      • nopInstance

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

      • 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.

      • 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.

      • isHandled

        @Deprecated
public boolean isHandled(Annotation ann)
        Deprecated. Not used since 2.0; deprecated sicne 2.1
        Method called by framework to determine whether given annotation is handled by this introspector.

      • 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.
        Since:
        2.0

      • findObjectIdInfo

        public ObjectIdInfo findObjectIdInfo(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.
        Since:
        2.0

      • findObjectReferenceInfo

        public ObjectIdInfo findObjectReferenceInfo(Annotated ann,
                                   ObjectIdInfo objectIdInfo)
        Method for figuring out additional properties of an Object Identity reference
        Since:
        2.1

      • findRootName

        public PropertyName findRootName(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.

        NOTE: method signature changed in 2.1, to return PropertyName instead of String.

      • findPropertiesToIgnore

        public String[] findPropertiesToIgnore(Annotated ac)
        Method for finding list of properties to ignore for given class (null is returned if not specified). List of property names is applied after other detection mechanisms, to filter out these specific properties from being serialized and deserialized.

      • findIgnoreUnknownProperties

        public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
        Method for checking whether an annotation indicates that all unknown properties

      • isIgnorableType

        public Boolean isIgnorableType(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:
        ac - Type to check
        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')

      • findFilterId

        public Object findFilterId(AnnotatedClass ac)
        Method for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.
        Returns:
        Id of the filter to use for filtering properties of annotated class, if any; or null if none found.

      • findAutoDetectVisibility

        public VisibilityChecker<?> findAutoDetectVisibility(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).

      • findTypeResolver

        public TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config,
                                      AnnotatedClass ac,
                                      JavaType baseType)
        Method for checking if given class has annotations that indicate that specific type resolver is to be used for handling instances. This includes not only instantiating resolver builder, but also configuring it based on relevant annotations (not including ones checked with a call to findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
        Parameters:
        config - Configuration settings in effect (for serialization or deserialization)
        ac - Annotated class to check for annotations
        baseType - Base java type of value for which resolver is to be found
        Returns:
        Type resolver builder for given type, if one found; null if none

      • findPropertyTypeResolver

        public TypeResolverBuilder<?> findPropertyTypeResolver(MapperConfig<?> config,
                                              AnnotatedMember am,
                                              JavaType baseType)
        Method for checking if given property entity (field or method) has annotations that indicate that specific type resolver is to be used for handling instances. This includes not only instantiating resolver builder, but also configuring it based on relevant annotations (not including ones checked with a call to findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
        Parameters:
        config - Configuration settings in effect (for serialization or deserialization)
        am - Annotated member (field or method) to check for annotations
        baseType - Base java type of property for which resolver is to be found
        Returns:
        Type resolver builder for properties of given entity, if one found; null if none

      • findPropertyContentTypeResolver

        public TypeResolverBuilder<?> findPropertyContentTypeResolver(MapperConfig<?> config,
                                                     AnnotatedMember am,
                                                     JavaType containerType)
        Method for checking if given structured property entity (field or method that has nominal value of Map, Collection or array type) has annotations that indicate that specific type resolver is to be used for handling type information of contained values. This includes not only instantiating resolver builder, but also configuring it based on relevant annotations (not including ones checked with a call to findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
        Parameters:
        config - Configuration settings in effect (for serialization or deserialization)
        am - Annotated member (field or method) to check for annotations
        containerType - Type of property for which resolver is to be found (must be a container type)
        Returns:
        Type resolver builder for values contained in properties of given entity, if one found; null if none

      • findSubtypes

        public List<NamedType> findSubtypes(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:
        a - Annotated entity (class, field/method) to check for annotations

      • findTypeName

        public String findTypeName(AnnotatedClass ac)
        Method for checking if specified type has explicit name.
        Parameters:
        ac - Class to check for type name annotations

      • findUnwrappingNameTransformer

        public NameTransformer findUnwrappingNameTransformer(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).

      • hasIgnoreMarker

        public boolean hasIgnoreMarker(AnnotatedMember m)
        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).

      • findInjectableValueId

        public Object findInjectableValueId(AnnotatedMember m)
        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:
        m - Member to check
        Returns:
        Identifier of value to inject, if any; null if no injection indicator is found

      • hasRequiredMarker

        public Boolean hasRequiredMarker(AnnotatedMember m)
        Method that can be called to check whether this member has an annotation that suggests whether value for matching property is required or not.
        Since:
        2.0

      • findViews

        public Class<?>[] findViews(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)
        Parameters:
        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

        @Deprecated
public JsonFormat.Value findFormat(AnnotatedMember member)
        Deprecated. Since 2.1, use findFormat(Annotated) instead.
        Method for finding format annotations for given member. Return value is typically used by serializers and/or deserializers to customize presentation aspects of the serialized value.
        Since:
        2.0

      • findFormat

        public JsonFormat.Value findFormat(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.
        Since:
        2.1

      • isTypeId

        public Boolean isTypeId(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.
        Since:
        2.0

      • findWrapperName

        public PropertyName findWrapperName(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 (2.1) it is only used by XML-backed handlers.
        Returns:
        Wrapper name to use, if any, or PropertyName.USE_DEFAULT to indicate that no wrapper element should be used.
        Since:
        2.1

      • findSerializer

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

      • findKeySerializer

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

      • findContentSerializer

        public Object findContentSerializer(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 JsonSerializer) or Class (of type Class); if value of different type is returned, a runtime exception may be thrown by caller.

      • findSerializationInclusion

        public JsonInclude.Include findSerializationInclusion(Annotated a,
                                             JsonInclude.Include defValue)
        Method for checking whether given annotated entity (class, method, field) defines which Bean/Map properties are to be included in serialization. If no annotation is found, method should return given second argument; otherwise value indicated by the annotation
        Returns:
        Enumerated value indicating which properties to include in serialization

      • findSerializationType

        public Class<?> findSerializationType(Annotated a)
        Method for accessing annotated type definition that a method/field can have, to be used as the type for serialization instead of the runtime type. Type returned (if any) needs to be widening conversion (super-type). Declared return type of the method is also considered acceptable.
        Returns:
        Class to use instead of runtime type

      • findSerializationKeyType

        public Class<?> findSerializationKeyType(Annotated am,
                                JavaType baseType)
        Method for finding possible widening type definition that a property value can have, to define less specific key type to use for serialization. It should be only be used with Map types.
        Returns:
        Class specifying more general type to use instead of declared type, if annotation found; null if not

      • findSerializationContentType

        public Class<?> findSerializationContentType(Annotated am,
                                    JavaType baseType)
        Method for finding possible widening type definition that a property value can have, to define less specific key type to use for serialization. It should be only used with structured types (arrays, collections, maps).
        Returns:
        Class specifying more general type to use instead of declared type, if annotation found; null if not

      • findSerializationTyping

        public JsonSerialize.Typing findSerializationTyping(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

      • findSerializationPropertyOrder

        public String[] findSerializationPropertyOrder(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(AnnotatedClass ac)
        Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered

      • findNameForSerialization

        public PropertyName findNameForSerialization(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.
        Since:
        2.1

      • findSerializationName

        @Deprecated
public String findSerializationName(AnnotatedMethod am)
        Deprecated. Since 2.1 should use findNameForSerialization(com.fasterxml.jackson.databind.introspect.Annotated) instead
        Method for checking whether given method has an annotation that suggests property name associated with method that may be a "getter". Should return null if no annotation is found; otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use standard bean name detection if applicable; method name if not".

      • findSerializationName

        @Deprecated
public String findSerializationName(AnnotatedField af)
        Deprecated. Since 2.1 should use findNameForSerialization(com.fasterxml.jackson.databind.introspect.Annotated) instead
        Method for checking whether given member field represent a serializable logical property; and if so, returns the name of that property. Should return null if no annotation is found (indicating it is not a serializable field); otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use the field name as is".

      • hasAsValueAnnotation

        public boolean hasAsValueAnnotation(AnnotatedMethod am)
        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:
        True if such annotation is found (and is not disabled); false if no enabled annotation is found

      • findEnumValue

        public String findEnumValue(Enum<?> value)
        Method for determining the String value to use for serializing given enumeration entry; used when serializing enumerations as Strings (the standard method).
        Returns:
        Serialized enum value.

      • findDeserializer

        public Object findDeserializer(Annotated am)
        Method for getting a deserializer definition on specified method or field. Type of definition is either instance (of type JsonDeserializer) or Class (of type Class); if value of different type is returned, a runtime exception may be thrown by caller.

      • findKeyDeserializer

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

      • findContentDeserializer

        public Object findContentDeserializer(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 JsonDeserializer) or Class (of type Class); if value of different type is returned, a runtime exception may be thrown by caller.

      • findDeserializationType

        public Class<?> findDeserializationType(Annotated am,
                               JavaType baseType)
        Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type. Type must be a narrowing conversion (i.e.subtype of declared type). Declared return type of the method is also considered acceptable.
        Parameters:
        baseType - Assumed type before considering annotations
        Returns:
        Class to use for deserialization instead of declared type

      • findDeserializationKeyType

        public Class<?> findDeserializationKeyType(Annotated am,
                                  JavaType baseKeyType)
        Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use. It should be only be used with Map types.
        Parameters:
        baseKeyType - Assumed key type before considering annotations
        Returns:
        Class specifying more specific type to use instead of declared type, if annotation found; null if not

      • findDeserializationContentType

        public Class<?> findDeserializationContentType(Annotated am,
                                      JavaType baseContentType)
        Method for accessing additional narrowing type definition that a method can have, to define more specific content type to use; content refers to Map values and Collection/array elements. It should be only be used with Map, Collection and array types.
        Parameters:
        baseContentType - Assumed content (value) type before considering annotations
        Returns:
        Class specifying more specific type to use instead of declared type, if annotation found; null if not

      • findValueInstantiator

        public Object findValueInstantiator(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.

      • findPOJOBuilder

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

        Since:
        2.0

      • findNameForDeserialization

        public PropertyName findNameForDeserialization(Annotated a)
        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:
        a - Property accessor to check
        Returns:
        Name to use if found; null if not.
        Since:
        2.1

      • findDeserializationName

        @Deprecated
public String findDeserializationName(AnnotatedMethod am)
        Deprecated. Since 2.1 should use findNameForDeserialization(com.fasterxml.jackson.databind.introspect.Annotated) instead
        Method for checking whether given method has an annotation that suggests property name associated with method that may be a "setter". Should return null if no annotation is found; otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use standard bean name detection if applicable; method name if not".

      • findDeserializationName

        @Deprecated
public String findDeserializationName(AnnotatedField af)
        Deprecated. Since 2.1 should use findNameForDeserialization(com.fasterxml.jackson.databind.introspect.Annotated) instead
        Method for checking whether given member field represent a deserializable logical property; and if so, returns the name of that property. Should return null if no annotation is found (indicating it is not a deserializable field); otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use the field name as is".

      • hasAnySetterAnnotation

        public boolean hasAnySetterAnnotation(AnnotatedMethod am)
        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.
        Returns:
        True if such annotation is found (and is not disabled), false otherwise

      • hasAnyGetterAnnotation

        public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
        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.
        Returns:
        True if such annotation is found (and is not disabled), false otherwise

      • hasCreatorAnnotation

        public boolean hasCreatorAnnotation(Annotated a)
        Method for checking whether given annotated item (method, constructor) has an annotation that suggests that the method is a "creator" (aka factory) method to be used for construct new instances of deserialized values.
        Returns:
        True if such annotation is found (and is not disabled), false otherwise

Copyright © 2012 FasterXML. All Rights Reserved.