Class JacksonAnnotationIntrospector
- java.lang.Object
-
- com.fasterxml.jackson.databind.AnnotationIntrospector
-
- com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector
-
- All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned,Serializable
public class JacksonAnnotationIntrospector extends AnnotationIntrospector implements Serializable
AnnotationIntrospectorimplementation that handles standard Jackson annotations.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.AnnotationIntrospector
AnnotationIntrospector.ReferenceProperty
-
-
Field Summary
Fields Modifier and Type Field Description protected LRUMap<Class<?>,Boolean>_annotationsInsideSince introspection of annotation types is a performance issue in some use cases (rare, but do exist), let's try a simple cache to reduce need for actual meta-annotation introspection.protected boolean_cfgConstructorPropertiesImpliesCreatorSeesetConstructorPropertiesImpliesCreator(boolean)for explanation.
-
Constructor Summary
Constructors Constructor Description JacksonAnnotationIntrospector()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected Class<?>_classIfExplicit(Class<?> cls)protected Class<?>_classIfExplicit(Class<?> cls, Class<?> implicit)protected StdTypeResolverBuilder_constructNoTypeResolverBuilder()Helper method for dealing with "no type info" marker; can't be null (as it'd be replaced by default typing)protected StdTypeResolverBuilder_constructStdTypeResolverBuilder()Helper method for constructing standardTypeResolverBuilderimplementation.protected BeanPropertyWriter_constructVirtualProperty(JsonAppend.Attr attr, MapperConfig<?> config, AnnotatedClass ac, JavaType type)protected BeanPropertyWriter_constructVirtualProperty(JsonAppend.Prop prop, MapperConfig<?> config, AnnotatedClass ac)protected PropertyName_findConstructorName(Annotated a)protected TypeResolverBuilder<?>_findTypeResolver(MapperConfig<?> config, Annotated ann, JavaType baseType)Helper method called to construct and initialize instance ofTypeResolverBuilderif given annotated element indicates one is needed.protected boolean_isIgnorable(Annotated a)protected PropertyName_propertyName(String localName, String namespace)voidfindAndAddVirtualProperties(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties)Method for adding possible virtual properties to be serialized along with regular properties.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).StringfindClassDescription(AnnotatedClass ac)Method used to check whether specified class defines a human-readable description to use for documentation.ObjectfindContentDeserializer(Annotated a)Method for getting a deserializer definition for content (values) of associatedCollection,arrayorMapproperty.ObjectfindContentSerializer(Annotated a)Method for getting a serializer definition for content (values) of associatedCollection,arrayorMapproperty.com.fasterxml.jackson.annotation.JsonCreator.ModefindCreatorAnnotation(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, whichJsonCreator.Modeto use.com.fasterxml.jackson.annotation.JsonCreator.ModefindCreatorBinding(Annotated a)Deprecated.Enum<?>findDefaultEnumValue(Class<Enum<?>> enumCls)Finds the Enum value that should be considered the default value, if possible.ObjectfindDeserializationContentConverter(AnnotatedMember a)Method for findingConverterthat 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).Class<?>findDeserializationContentType(Annotated am, JavaType baseContentType)Deprecated.ObjectfindDeserializationConverter(Annotated a)Method for findingConverterthat annotated entity (property or class) has indicated to be used as part of deserialization.Class<?>findDeserializationKeyType(Annotated am, JavaType baseKeyType)Deprecated.Class<?>findDeserializationType(Annotated am, JavaType baseType)Deprecated.ObjectfindDeserializer(Annotated a)Method for getting a deserializer definition on specified method or field.StringfindEnumValue(Enum<?> value)Deprecated.String[]findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names)Method for efficiently figuring out which if given set ofEnumvalues have explicitly defined name.ObjectfindFilterId(Annotated a)Method for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.com.fasterxml.jackson.annotation.JsonFormat.ValuefindFormat(Annotated ann)Method for finding format annotations for property or class.StringfindImplicitPropertyName(AnnotatedMember m)Method for finding implicit name for a property that given annotated member (field, method, creator parameter) may represent.com.fasterxml.jackson.annotation.JacksonInject.ValuefindInjectableValue(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.ObjectfindInjectableValueId(AnnotatedMember m)Deprecated.ObjectfindKeyDeserializer(Annotated a)Method for getting a deserializer definition for keys of associatedMapproperty.ObjectfindKeySerializer(Annotated a)Method for getting a serializer definition for keys of associatedjava.util.Mapproperty.BooleanfindMergeInfo(Annotated a)Method for finding merge settings for property, if any.PropertyNamefindNameForDeserialization(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).PropertyNamefindNameForSerialization(Annotated a)Method for checking whether given property accessors (method, field) has an annotation that suggests property name to use for serialization.ObjectfindNamingStrategy(AnnotatedClass ac)Method for findingPropertyNamingStrategyfor given class, if any specified by annotations; and if so, either return aPropertyNamingStrategyinstance, or Class to use for creating instanceObjectfindNullSerializer(Annotated a)Method for getting a serializer definition for serializer to use for nulls (null values) of associated property or type.ObjectIdInfofindObjectIdInfo(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.ObjectIdInfofindObjectReferenceInfo(Annotated ann, ObjectIdInfo objectIdInfo)Method for figuring out additional properties of an Object Identity referenceClass<?>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).JsonPOJOBuilder.ValuefindPOJOBuilderConfig(AnnotatedClass ac)com.fasterxml.jackson.annotation.JsonProperty.AccessfindPropertyAccess(Annotated m)Method for finding optional access definition for a property, annotated on one of its accessors.List<PropertyName>findPropertyAliases(Annotated m)Method called to find if given property has alias(es) defined.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.StringfindPropertyDefaultValue(Annotated ann)Method for finding suggested default value (as simple textual serialization) for the property.StringfindPropertyDescription(Annotated ann)Method used to check whether specified property member (accessor or mutator) defines human-readable description to use for documentation.com.fasterxml.jackson.annotation.JsonIgnoreProperties.ValuefindPropertyIgnorals(Annotated a)Method for finding information about properties to ignore either by name, or by more general specification ("ignore all unknown").com.fasterxml.jackson.annotation.JsonInclude.ValuefindPropertyInclusion(Annotated a)Method for checking inclusion criteria for a type (Class) or property (yes, method name is bit unfortunate -- not just for properties!).IntegerfindPropertyIndex(Annotated ann)Method used to check whether specified property member (accessor or mutator) defines numeric index, and if so, what is the index value.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.AnnotationIntrospector.ReferencePropertyfindReferenceType(AnnotatedMember member)Method for checking if given member indicates that it is part of a reference (parent/child).PropertyNamefindRootName(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.ObjectfindSerializationContentConverter(AnnotatedMember a)Method for findingConverterthat 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).Class<?>findSerializationContentType(Annotated am, JavaType baseType)Deprecated.ObjectfindSerializationConverter(Annotated a)Method for findingConverterthat annotated entity (property or class) has indicated to be used as part of serialization.Class<?>findSerializationKeyType(Annotated am, JavaType baseType)Deprecated.String[]findSerializationPropertyOrder(AnnotatedClass ac)Method for accessing defined property serialization order (which may be partial).BooleanfindSerializationSortAlphabetically(Annotated ann)Method for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) orderedClass<?>findSerializationType(Annotated am)Deprecated.JsonSerialize.TypingfindSerializationTyping(Annotated a)Method for accessing declared typing mode annotated (if any).ObjectfindSerializer(Annotated a)Method for getting a serializer definition on specified method or field.com.fasterxml.jackson.annotation.JsonSetter.ValuefindSetterInfo(Annotated a)Method for finding possible settings for property, given annotations on an accessor.List<NamedType>findSubtypes(Annotated a)Method for locating annotation-specified subtypes related to annotated entity (class, method, field).StringfindTypeName(AnnotatedClass ac)Method for checking if specified type has explicit name.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.NameTransformerfindUnwrappingNameTransformer(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.ObjectfindValueInstantiator(AnnotatedClass ac)Method gettingValueInstantiatorto use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.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.BooleanhasAnyGetter(Annotated a)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.booleanhasAnyGetterAnnotation(AnnotatedMethod am)Deprecated.BooleanhasAnySetter(Annotated a)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.booleanhasAnySetterAnnotation(AnnotatedMethod am)Deprecated.BooleanhasAsValue(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.booleanhasAsValueAnnotation(AnnotatedMethod am)Deprecated.booleanhasCreatorAnnotation(Annotated a)Deprecated.booleanhasIgnoreMarker(AnnotatedMember m)Method called to check whether given property is marked to be ignored.BooleanhasRequiredMarker(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.booleanisAnnotationBundle(Annotation ann)Annotations with meta-annotationJacksonAnnotationsInsideare considered bundles.BooleanisIgnorableType(AnnotatedClass ac)Method for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes.BooleanisTypeId(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.protected ObjectreadResolve()JavaTyperefineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType)Method called to find out possible type refinements to use for deserialization.JavaTyperefineSerializationType(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.AnnotatedMethodresolveSetterConflict(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.JacksonAnnotationIntrospectorsetConstructorPropertiesImpliesCreator(boolean b)Method for changing behavior ofConstructorProperties: if set to `true`, existence DOES indicate that the given constructor should be considered a creator; `false` that it should NOT be considered a creator without explicit use ofJsonCreatorannotation.com.fasterxml.jackson.core.Versionversion()-
Methods inherited from class com.fasterxml.jackson.databind.AnnotationIntrospector
_findAnnotation, _hasAnnotation, _hasOneOf, allIntrospectors, allIntrospectors, findIgnoreUnknownProperties, findPropertiesToIgnore, findPropertiesToIgnore, findSerializationInclusion, findSerializationInclusionForContent, findWrapperName, nopInstance, pair
-
-
-
-
Field Detail
-
_annotationsInside
protected transient LRUMap<Class<?>,Boolean> _annotationsInside
Since introspection of annotation types is a performance issue in some use cases (rare, but do exist), let's try a simple cache to reduce need for actual meta-annotation introspection.Non-final only because it needs to be re-created after deserialization.
- Since:
- 2.7
-
_cfgConstructorPropertiesImpliesCreator
protected boolean _cfgConstructorPropertiesImpliesCreator
SeesetConstructorPropertiesImpliesCreator(boolean)for explanation.Defaults to true.
- Since:
- 2.7.4
-
-
Method Detail
-
version
public com.fasterxml.jackson.core.Version version()
- Specified by:
versionin interfacecom.fasterxml.jackson.core.Versioned- Specified by:
versionin classAnnotationIntrospector
-
readResolve
protected Object readResolve()
-
setConstructorPropertiesImpliesCreator
public JacksonAnnotationIntrospector setConstructorPropertiesImpliesCreator(boolean b)
Method for changing behavior ofConstructorProperties: if set to `true`, existence DOES indicate that the given constructor should be considered a creator; `false` that it should NOT be considered a creator without explicit use ofJsonCreatorannotation.Default setting is `true`
- Since:
- 2.7.4
-
isAnnotationBundle
public boolean isAnnotationBundle(Annotation ann)
Annotations with meta-annotationJacksonAnnotationsInsideare considered bundles.- Overrides:
isAnnotationBundlein classAnnotationIntrospector
-
findEnumValue
@Deprecated public String findEnumValue(Enum<?> value)
Deprecated.Since 2.6, we have supported use ofJsonPropertyfor specifying explicit serialized name- Overrides:
findEnumValuein classAnnotationIntrospector- Returns:
- Serialized enum value.
-
findEnumValues
public String[] findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names)
Description copied from class:AnnotationIntrospectorMethod for efficiently figuring out which if given set ofEnumvalues have explicitly defined name. Method will overwrite entries in incomingnamesarray with explicit names found, if any, leaving other entries unmodified.Default implementation will simply delegate to
AnnotationIntrospector.findEnumValue(java.lang.Enum<?>), which is close enough, although unfortunately NOT 100% equivalent (as it will also considername()to give explicit value).- Overrides:
findEnumValuesin classAnnotationIntrospector
-
findDefaultEnumValue
public Enum<?> findDefaultEnumValue(Class<Enum<?>> enumCls)
Finds the Enum value that should be considered the default value, if possible.This implementation relies on
JsonEnumDefaultValueannotation to determine the default value if present.- Overrides:
findDefaultEnumValuein classAnnotationIntrospector- Parameters:
enumCls- The Enum class to scan for the default value.- Returns:
- null if none found or it's not possible to determine one.
- Since:
- 2.8
-
findRootName
public PropertyName findRootName(AnnotatedClass ac)
Description copied from class:AnnotationIntrospectorMethod 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
PropertyNameinstead of String.- Overrides:
findRootNamein classAnnotationIntrospector
-
findPropertyIgnorals
public com.fasterxml.jackson.annotation.JsonIgnoreProperties.Value findPropertyIgnorals(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for finding information about properties to ignore either by name, or by more general specification ("ignore all unknown"). This method combines multiple aspects of ignorals and deprecates earlier methods such asAnnotationIntrospector.findPropertiesToIgnore(Annotated, boolean)andAnnotationIntrospector.findIgnoreUnknownProperties(AnnotatedClass).- Overrides:
findPropertyIgnoralsin classAnnotationIntrospector
-
isIgnorableType
public Boolean isIgnorableType(AnnotatedClass ac)
Description copied from class:AnnotationIntrospectorMethod for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes.- Overrides:
isIgnorableTypein classAnnotationIntrospector- 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(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for finding if annotated class has associated filter; and if so, to return id that is used to locate filter.- Overrides:
findFilterIdin classAnnotationIntrospector- 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)
Description copied from class:AnnotationIntrospectorMethod for findingPropertyNamingStrategyfor given class, if any specified by annotations; and if so, either return aPropertyNamingStrategyinstance, or Class to use for creating instance- Overrides:
findNamingStrategyin classAnnotationIntrospector- Returns:
- Sub-class or instance of
PropertyNamingStrategy, if one is specified for given class; null if not.
-
findClassDescription
public String findClassDescription(AnnotatedClass ac)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findClassDescriptionin classAnnotationIntrospector- Returns:
- Human-readable description, if any.
-
findAutoDetectVisibility
public VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)
Description copied from class:AnnotationIntrospectorMethod 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).- Overrides:
findAutoDetectVisibilityin classAnnotationIntrospector
-
findImplicitPropertyName
public String findImplicitPropertyName(AnnotatedMember m)
Description copied from class:AnnotationIntrospectorMethod 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 cannot be detected by standard databind); or to provide alternate name mangling for fields, getters and/or setters.- Overrides:
findImplicitPropertyNamein classAnnotationIntrospector
-
findPropertyAliases
public List<PropertyName> findPropertyAliases(Annotated m)
Description copied from class:AnnotationIntrospectorMethod called to find if given property has alias(es) defined.- Overrides:
findPropertyAliasesin classAnnotationIntrospector- Returns:
- `null` if member has no information; otherwise a `List` (possibly empty) of aliases to use.
-
hasIgnoreMarker
public boolean hasIgnoreMarker(AnnotatedMember m)
Description copied from class:AnnotationIntrospectorMethod 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).- Overrides:
hasIgnoreMarkerin classAnnotationIntrospector
-
hasRequiredMarker
public Boolean hasRequiredMarker(AnnotatedMember m)
Description copied from class:AnnotationIntrospectorMethod that can be called to check whether this member has an annotation that suggests whether value for matching property is required or not.- Overrides:
hasRequiredMarkerin classAnnotationIntrospector
-
findPropertyAccess
public com.fasterxml.jackson.annotation.JsonProperty.Access findPropertyAccess(Annotated m)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findPropertyAccessin classAnnotationIntrospector
-
findPropertyDescription
public String findPropertyDescription(Annotated ann)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findPropertyDescriptionin classAnnotationIntrospector- Returns:
- Human-readable description, if any.
-
findPropertyIndex
public Integer findPropertyIndex(Annotated ann)
Description copied from class:AnnotationIntrospectorMethod 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).- Overrides:
findPropertyIndexin classAnnotationIntrospector- Returns:
- Explicitly specified index for the property, if any
-
findPropertyDefaultValue
public String findPropertyDefaultValue(Annotated ann)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findPropertyDefaultValuein classAnnotationIntrospector
-
findFormat
public com.fasterxml.jackson.annotation.JsonFormat.Value findFormat(Annotated ann)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findFormatin classAnnotationIntrospector
-
findReferenceType
public AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
Description copied from class:AnnotationIntrospectorMethod for checking if given member indicates that it is part of a reference (parent/child).- Overrides:
findReferenceTypein classAnnotationIntrospector
-
findUnwrappingNameTransformer
public NameTransformer findUnwrappingNameTransformer(AnnotatedMember member)
Description copied from class:AnnotationIntrospectorMethod 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).- Overrides:
findUnwrappingNameTransformerin classAnnotationIntrospector
-
findInjectableValue
public com.fasterxml.jackson.annotation.JacksonInject.Value findInjectableValue(AnnotatedMember m)
Description copied from class:AnnotationIntrospectorMethod 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 typeInjectableValues); often a simple String id is used.- Overrides:
findInjectableValuein classAnnotationIntrospector- Parameters:
m- Member to check- Returns:
- Identifier of value to inject, if any; null if no injection indicator is found
-
findInjectableValueId
@Deprecated public Object findInjectableValueId(AnnotatedMember m)
Deprecated.- Overrides:
findInjectableValueIdin classAnnotationIntrospector
-
findViews
public Class<?>[] findViews(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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- Overrides:
findViewsin classAnnotationIntrospector- 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)
-
resolveSetterConflict
public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config, AnnotatedMethod setter1, AnnotatedMethod setter2)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
resolveSetterConflictin classAnnotationIntrospector
-
findTypeResolver
public TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)
Description copied from class:AnnotationIntrospectorMethod 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 toAnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)- Overrides:
findTypeResolverin classAnnotationIntrospector- Parameters:
config- Configuration settings in effect (for serialization or deserialization)ac- Annotated class to check for annotationsbaseType- 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)
Description copied from class:AnnotationIntrospectorMethod 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 toAnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)- Overrides:
findPropertyTypeResolverin classAnnotationIntrospector- Parameters:
config- Configuration settings in effect (for serialization or deserialization)am- Annotated member (field or method) to check for annotationsbaseType- 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)
Description copied from class:AnnotationIntrospectorMethod 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 toAnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)- Overrides:
findPropertyContentTypeResolverin classAnnotationIntrospector- Parameters:
config- Configuration settings in effect (for serialization or deserialization)am- Annotated member (field or method) to check for annotationscontainerType- 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)
Description copied from class:AnnotationIntrospectorMethod 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)- Overrides:
findSubtypesin classAnnotationIntrospector- Parameters:
a- Annotated entity (class, field/method) to check for annotations
-
findTypeName
public String findTypeName(AnnotatedClass ac)
Description copied from class:AnnotationIntrospectorMethod for checking if specified type has explicit name.- Overrides:
findTypeNamein classAnnotationIntrospector- Parameters:
ac- Class to check for type name annotations
-
isTypeId
public Boolean isTypeId(AnnotatedMember member)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
isTypeIdin classAnnotationIntrospector
-
findObjectIdInfo
public ObjectIdInfo findObjectIdInfo(Annotated ann)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findObjectIdInfoin classAnnotationIntrospector
-
findObjectReferenceInfo
public ObjectIdInfo findObjectReferenceInfo(Annotated ann, ObjectIdInfo objectIdInfo)
Description copied from class:AnnotationIntrospectorMethod for figuring out additional properties of an Object Identity reference- Overrides:
findObjectReferenceInfoin classAnnotationIntrospector
-
findSerializer
public Object findSerializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a serializer definition on specified method or field. Type of definition is either instance (of typeJsonSerializer) or Class (ofClass<JsonSerializer>implementation subtype); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findSerializerin classAnnotationIntrospector
-
findKeySerializer
public Object findKeySerializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a serializer definition for keys of associatedjava.util.Mapproperty. Type of definition is either instance (of typeJsonSerializer) or Class (of typeClass<JsonSerializer>); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findKeySerializerin classAnnotationIntrospector
-
findContentSerializer
public Object findContentSerializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a serializer definition for content (values) of associatedCollection,arrayorMapproperty. Type of definition is either instance (of typeJsonSerializer) or Class (of typeClass<JsonSerializer>); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findContentSerializerin classAnnotationIntrospector
-
findNullSerializer
public Object findNullSerializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a serializer definition for serializer to use for nulls (null values) of associated property or type.- Overrides:
findNullSerializerin classAnnotationIntrospector
-
findPropertyInclusion
public com.fasterxml.jackson.annotation.JsonInclude.Value findPropertyInclusion(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findPropertyInclusionin classAnnotationIntrospector
-
findSerializationTyping
public JsonSerialize.Typing findSerializationTyping(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findSerializationTypingin classAnnotationIntrospector- Returns:
- Typing mode to use, if annotation is found; null otherwise
-
findSerializationConverter
public Object findSerializationConverter(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for findingConverterthat annotated entity (property or class) has indicated to be used as part of serialization. If not null, either has to be actualConverterinstance, 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.
- Overrides:
findSerializationConverterin classAnnotationIntrospector- Parameters:
a- Annotated property (field, method) or class to check for annotations
-
findSerializationContentConverter
public Object findSerializationContentConverter(AnnotatedMember a)
Description copied from class:AnnotationIntrospectorMethod for findingConverterthat 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
Converterinstance, 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
AnnotationIntrospector.findSerializationConverter(com.fasterxml.jackson.databind.introspect.Annotated)- Overrides:
findSerializationContentConverterin classAnnotationIntrospector- Parameters:
a- Annotated property (field, method) to check.
-
refineSerializationType
public JavaType refineSerializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
refineSerializationTypein classAnnotationIntrospector- Throws:
JsonMappingException
-
findSerializationType
@Deprecated public Class<?> findSerializationType(Annotated am)
Deprecated.- Overrides:
findSerializationTypein classAnnotationIntrospector
-
findSerializationKeyType
@Deprecated public Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
Deprecated.- Overrides:
findSerializationKeyTypein classAnnotationIntrospector
-
findSerializationContentType
@Deprecated public Class<?> findSerializationContentType(Annotated am, JavaType baseType)
Deprecated.- Overrides:
findSerializationContentTypein classAnnotationIntrospector
-
findSerializationPropertyOrder
public String[] findSerializationPropertyOrder(AnnotatedClass ac)
Description copied from class:AnnotationIntrospectorMethod for accessing defined property serialization order (which may be partial). May return null if no ordering is defined.- Overrides:
findSerializationPropertyOrderin classAnnotationIntrospector
-
findSerializationSortAlphabetically
public Boolean findSerializationSortAlphabetically(Annotated ann)
Description copied from class:AnnotationIntrospectorMethod for checking whether an annotation indicates that serialized properties for which no explicit is defined should be alphabetically (lexicograpically) ordered- Overrides:
findSerializationSortAlphabeticallyin classAnnotationIntrospector
-
findAndAddVirtualProperties
public void findAndAddVirtualProperties(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties)
Description copied from class:AnnotationIntrospectorMethod for adding possible virtual properties to be serialized along with regular properties.- Overrides:
findAndAddVirtualPropertiesin classAnnotationIntrospector
-
_constructVirtualProperty
protected BeanPropertyWriter _constructVirtualProperty(JsonAppend.Attr attr, MapperConfig<?> config, AnnotatedClass ac, JavaType type)
-
_constructVirtualProperty
protected BeanPropertyWriter _constructVirtualProperty(JsonAppend.Prop prop, MapperConfig<?> config, AnnotatedClass ac)
-
findNameForSerialization
public PropertyName findNameForSerialization(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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 (possiblyPropertyName.USE_DEFAULT, which means "use default heuristics").- Overrides:
findNameForSerializationin classAnnotationIntrospector- Parameters:
a- Property accessor to check- Returns:
- Name to use if found; null if not.
-
hasAsValue
public Boolean hasAsValue(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
hasAsValuein classAnnotationIntrospector- Returns:
Boolean.TRUEif such annotation is found and is not disabled;Boolean.FALSEif 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(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
hasAnyGetterin classAnnotationIntrospector- Returns:
- True if such annotation is found (and is not disabled), false otherwise
-
hasAnyGetterAnnotation
@Deprecated public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
Deprecated.- Overrides:
hasAnyGetterAnnotationin classAnnotationIntrospector
-
hasAsValueAnnotation
@Deprecated public boolean hasAsValueAnnotation(AnnotatedMethod am)
Deprecated.- Overrides:
hasAsValueAnnotationin classAnnotationIntrospector
-
findDeserializer
public Object findDeserializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a deserializer definition on specified method or field. Type of definition is either instance (of typeJsonDeserializer) or Class (of typeClass&<JsonDeserializer>); type is returned, a runtime exception may be thrown by caller.- Overrides:
findDeserializerin classAnnotationIntrospector
-
findKeyDeserializer
public Object findKeyDeserializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a deserializer definition for keys of associatedMapproperty. Type of definition is either instance (of typeJsonDeserializer) or Class (of typeClass<JsonDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findKeyDeserializerin classAnnotationIntrospector
-
findContentDeserializer
public Object findContentDeserializer(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for getting a deserializer definition for content (values) of associatedCollection,arrayorMapproperty. Type of definition is either instance (of typeJsonDeserializer) or Class (of typeClass<JsonDeserializer>); if value of different type is returned, a runtime exception may be thrown by caller.- Overrides:
findContentDeserializerin classAnnotationIntrospector
-
findDeserializationConverter
public Object findDeserializationConverter(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for findingConverterthat annotated entity (property or class) has indicated to be used as part of deserialization. If not null, either has to be actualConverterinstance, 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.
- Overrides:
findDeserializationConverterin classAnnotationIntrospector- Parameters:
a- Annotated property (field, method) or class to check for annotations
-
findDeserializationContentConverter
public Object findDeserializationContentConverter(AnnotatedMember a)
Description copied from class:AnnotationIntrospectorMethod for findingConverterthat 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
Converterinstance, 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
AnnotationIntrospector.findDeserializationConverter(com.fasterxml.jackson.databind.introspect.Annotated)- Overrides:
findDeserializationContentConverterin classAnnotationIntrospector- Parameters:
a- Annotated property (field, method) to check.
-
refineDeserializationType
public JavaType refineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException
Description copied from class:AnnotationIntrospectorMethod called to find out possible type refinements to use for deserialization.- Overrides:
refineDeserializationTypein classAnnotationIntrospector- Throws:
JsonMappingException
-
findDeserializationContentType
@Deprecated public Class<?> findDeserializationContentType(Annotated am, JavaType baseContentType)
Deprecated.Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
findDeserializationContentTypein classAnnotationIntrospectorbaseContentType- 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
-
findDeserializationType
@Deprecated public Class<?> findDeserializationType(Annotated am, JavaType baseType)
Deprecated.Description copied from class:AnnotationIntrospectorMethod for accessing annotated type definition that a property can have, to be used as the type for deserialization instead of the static (declared) type. Type is usually narrowing conversion (i.e.subtype of declared type). Declared return type of the method is also considered acceptable.- Overrides:
findDeserializationTypein classAnnotationIntrospectorbaseType- Assumed type before considering annotations- Returns:
- Class to use for deserialization instead of declared type
-
findDeserializationKeyType
@Deprecated public Class<?> findDeserializationKeyType(Annotated am, JavaType baseKeyType)
Deprecated.Description copied from class:AnnotationIntrospectorMethod 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 withMaptypes.- Overrides:
findDeserializationKeyTypein classAnnotationIntrospectorbaseKeyType- Assumed key 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)
Description copied from class:AnnotationIntrospectorMethod gettingValueInstantiatorto use for given type (class): return value can either be an instance of instantiator, or class of instantiator to create.- Overrides:
findValueInstantiatorin classAnnotationIntrospector
-
findPOJOBuilder
public Class<?> findPOJOBuilder(AnnotatedClass ac)
Description copied from class:AnnotationIntrospectorMethod 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.
- Overrides:
findPOJOBuilderin classAnnotationIntrospector
-
findPOJOBuilderConfig
public JsonPOJOBuilder.Value findPOJOBuilderConfig(AnnotatedClass ac)
- Overrides:
findPOJOBuilderConfigin classAnnotationIntrospector
-
findNameForDeserialization
public PropertyName findNameForDeserialization(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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 (possiblyPropertyName.USE_DEFAULT, which means "use default heuristics").- Overrides:
findNameForDeserializationin classAnnotationIntrospector- Parameters:
a- Property accessor to check- Returns:
- Name to use if found; null if not.
-
hasAnySetter
public Boolean hasAnySetter(Annotated a)
Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
hasAnySetterin classAnnotationIntrospector- Returns:
- True if such annotation is found (and is not disabled), false otherwise
-
findSetterInfo
public com.fasterxml.jackson.annotation.JsonSetter.Value findSetterInfo(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for finding possible settings for property, given annotations on an accessor.- Overrides:
findSetterInfoin classAnnotationIntrospector
-
findMergeInfo
public Boolean findMergeInfo(Annotated a)
Description copied from class:AnnotationIntrospectorMethod for finding merge settings for property, if any.- Overrides:
findMergeInfoin classAnnotationIntrospector
-
hasAnySetterAnnotation
@Deprecated public boolean hasAnySetterAnnotation(AnnotatedMethod am)
Deprecated.- Overrides:
hasAnySetterAnnotationin classAnnotationIntrospector
-
hasCreatorAnnotation
@Deprecated public boolean hasCreatorAnnotation(Annotated a)
Deprecated.Description copied from class:AnnotationIntrospectorMethod 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.- Overrides:
hasCreatorAnnotationin classAnnotationIntrospector- Returns:
- True if such annotation is found (and is not disabled), false otherwise
-
findCreatorBinding
@Deprecated public com.fasterxml.jackson.annotation.JsonCreator.Mode findCreatorBinding(Annotated a)
Deprecated.Description copied from class:AnnotationIntrospectorMethod for finding indication of creator binding mode for a creator (something for whichAnnotationIntrospector.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).- Overrides:
findCreatorBindingin classAnnotationIntrospector
-
findCreatorAnnotation
public com.fasterxml.jackson.annotation.JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated a)
Description copied from class:AnnotationIntrospectorMethod called to check whether potential Creator (constructor or static factory method) has explicit annotation to indicate it as actual Creator; and if so, whichJsonCreator.Modeto 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.- Overrides:
findCreatorAnnotationin classAnnotationIntrospector- Parameters:
config- Configuration settings in effect (for serialization or deserialization)a- Annotated accessor (usually constructor or static method) to check
-
_isIgnorable
protected boolean _isIgnorable(Annotated a)
-
_propertyName
protected PropertyName _propertyName(String localName, String namespace)
-
_findConstructorName
protected PropertyName _findConstructorName(Annotated a)
-
_findTypeResolver
protected TypeResolverBuilder<?> _findTypeResolver(MapperConfig<?> config, Annotated ann, JavaType baseType)
Helper method called to construct and initialize instance ofTypeResolverBuilderif given annotated element indicates one is needed.
-
_constructStdTypeResolverBuilder
protected StdTypeResolverBuilder _constructStdTypeResolverBuilder()
Helper method for constructing standardTypeResolverBuilderimplementation.
-
_constructNoTypeResolverBuilder
protected StdTypeResolverBuilder _constructNoTypeResolverBuilder()
Helper method for dealing with "no type info" marker; can't be null (as it'd be replaced by default typing)
-
-