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.

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

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

• version

  public abstract Version version()

  Specified by:

  version in interface 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.

  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

  @Deprecated
  public Object findFilterId(AnnotatedClass ac)

  Deprecated. Since 2.3: use the one that takes generic Annotated

• findFilterId

  public Object findFilterId(Annotated ann)

  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.

• findNamingStrategy

  public Object findNamingStrategy(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

  Returns:

  Sub-class or instance of PropertyNamingStrategy, if one is specified for given class; null if not.

  Since:

  2.1

• 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

• findReferenceType

  public AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)

  Method for checking if given member indicates that it is part of a reference (parent/child).

• 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

  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.

• 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

• findPropertyDefaultValue

  public String findPropertyDefaultValue(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.

  Since:

  2.5

• findPropertyDescription

  public String findPropertyDescription(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.

  Returns:

  Human-readable description, if any.

  Since:

  2.3

• findPropertyIndex

  public Integer findPropertyIndex(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).

  Returns:

  Explicitly specified index for the property, if any

  Since:

  2.4

• findImplicitPropertyName

  public String findImplicitPropertyName(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 proof 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 can not be detected by standard databind); or to provide alternate name mangling for fields, getters and/or setters.

  Since:

  2.4

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

• findNullSerializer

  public Object findNullSerializer(Annotated am)

  Method for getting a serializer definition for serializer to use for nulls (null values) of associated property or type.

  Since:

  2.3

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

  Note that meaning of inclusion value depends on whether it is for a Class or property (field/method/constructor): in former case, it is the default for all properties; in latter case it is specific override for annotated property.

  Returns:

  Enumerated value indicating which properties to include in serialization

• findSerializationInclusionForContent

  public JsonInclude.Include findSerializationInclusionForContent(Annotated a,
                                                         JsonInclude.Include defValue)

  Method for checking whether content (entries) of a Map property are to be included during serialization or not.

  Since:

  2.5

• 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

• findSerializationConverter

  public Object findSerializationConverter(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

  Since:

  2.2

• findSerializationContentConverter

  public Object findSerializationContentConverter(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(com.fasterxml.jackson.databind.introspect.Annotated)

  Parameters:

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

  Since:

  2.2

• 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(Annotated ann)

  Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered

• findSerializationSortAlphabetically

  @Deprecated
  public Boolean findSerializationSortAlphabetically(AnnotatedClass ac)

  Deprecated. 

• findAndAddVirtualProperties

  public void findAndAddVirtualProperties(MapperConfig<?> config,
                                 AnnotatedClass ac,
                                 List<BeanPropertyWriter> properties)

  Method for adding possible virtual properties to be serialized along with regular properties.

  Since:

  2.5

• 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

• 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

• findDeserializationConverter

  public Object findDeserializationConverter(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

  Since:

  2.2

• findDeserializationContentConverter

  public Object findDeserializationContentConverter(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(com.fasterxml.jackson.databind.introspect.Annotated)

  Parameters:

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

  Since:

  2.2

• 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

• findPOJOBuilderConfig

  public JsonPOJOBuilder.Value findPOJOBuilderConfig(AnnotatedClass ac)

  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

• 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

• findCreatorBinding

  public JsonCreator.Mode findCreatorBinding(Annotated a)

  Method for finding indication of creator binding mode for a creator (something for which hasCreatorAnnotation(com.fasterxml.jackson.databind.introspect.Annotated) returns true), for cases where there may be ambiguity (currently: single-argument creator with implicit but no explicit name for the argument).

  Since:

  2.5

• _findAnnotation

  protected <A extends Annotation> A _findAnnotation(Annotated annotated,
                                         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);

  Since:

  2.5

• _hasAnnotation

  protected boolean _hasAnnotation(Annotated annotated,
                       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);

  Since:

  2.5