public abstract class AnnotationIntrospector extends Object implements Versioned, Serializable
Although default implementations are based on using annotations as the only (or at least main) information source, custom implementations are not limited in such a way, and in fact there is no expectation they should be. So the name is bit of misnomer; this is a general configuration introspection facility.
NOTE: due to rapid addition of new methods (and changes to existing methods),
it is strongly recommended that custom implementations should not directly
extend this class, but rather extend NopAnnotationIntrospector
.
This way added methods will not break backwards compatibility of custom annotation
introspectors.
Modifier and Type | Class and Description |
---|---|
static class |
AnnotationIntrospector.ReferenceProperty
Value type used with managed and back references; contains type and
logic name, used to link related references
|
Constructor and Description |
---|
AnnotationIntrospector() |
Modifier and Type | Method and Description |
---|---|
protected <A extends Annotation> |
_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.
|
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.
|
protected boolean |
_hasOneOf(Annotated annotated,
Class<? extends Annotation>[] annoClasses)
Alternative lookup method that is used to see if annotation has at least one of
annotations of types listed in second argument.
|
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.
|
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.
|
void |
findAndAddVirtualProperties(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).
|
String |
findClassDescription(AnnotatedClass ac)
Method used to check whether specified class defines a human-readable
description to use for documentation.
|
Object |
findContentDeserializer(Annotated am)
Method for getting a deserializer definition for content (values) of
associated
Collection , array or
Map property. |
Object |
findContentSerializer(Annotated am)
Method for getting a serializer definition for content (values) of
associated
Collection , array or Map property. |
JsonCreator.Mode |
findCreatorAnnotation(MapperConfig<?> config,
Annotated a)
Method called to check whether potential Creator (constructor or static factory
method) has explicit annotation to indicate it as actual Creator; and if so,
which
JsonCreator.Mode to use. |
JsonCreator.Mode |
findCreatorBinding(Annotated a)
Deprecated.
|
Enum<?> |
findDefaultEnumValue(Class<Enum<?>> enumCls)
Finds the Enum value that should be considered the default value, if possible.
|
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). |
Class<?> |
findDeserializationContentType(Annotated am,
JavaType baseContentType)
|
Object |
findDeserializationConverter(Annotated a)
Method for finding
Converter that annotated entity
(property or class) has indicated to be used as part of
deserialization. |
Class<?> |
findDeserializationKeyType(Annotated am,
JavaType baseKeyType)
|
Class<?> |
findDeserializationType(Annotated am,
JavaType baseType)
|
Object |
findDeserializer(Annotated am)
Method for getting a deserializer definition on specified method
or field.
|
String |
findEnumValue(Enum<?> value)
Deprecated.
Since 2.8: use
findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[]) instead because this method
does not properly handle override settings (defaults to enum.name
without indicating whether that is explicit or not), and is inefficient to
call one-by-one. |
String[] |
findEnumValues(Class<?> enumType,
Enum<?>[] enumValues,
String[] names)
Method for efficiently figuring out which if given set of
Enum values
have explicitly defined name. |
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.
|
JsonFormat.Value |
findFormat(Annotated memberOrClass)
Method for finding format annotations for property or class.
|
Boolean |
findIgnoreUnknownProperties(AnnotatedClass ac)
Deprecated.
Since 2.8, use
findPropertyIgnorals(com.fasterxml.jackson.databind.introspect.Annotated) instead |
String |
findImplicitPropertyName(AnnotatedMember member)
Method for finding implicit name for a property that given annotated
member (field, method, creator parameter) may represent.
|
JacksonInject.Value |
findInjectableValue(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.
|
Object |
findInjectableValueId(AnnotatedMember m)
Deprecated.
Since 2.9 Use
findInjectableValue(com.fasterxml.jackson.databind.introspect.AnnotatedMember) instead |
Object |
findKeyDeserializer(Annotated am)
Method for getting a deserializer definition for keys of
associated
Map property. |
Object |
findKeySerializer(Annotated am)
Method for getting a serializer definition for keys of associated
Map property. |
Boolean |
findMergeInfo(Annotated a)
Method for finding merge settings for property, if any.
|
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).
|
PropertyName |
findNameForSerialization(Annotated a)
Method for checking whether given property accessors (method,
field) has an annotation that suggests property name to use
for serialization.
|
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 |
Object |
findNullSerializer(Annotated am)
Method for getting a serializer definition for serializer to use
for nulls (null values) of associated property or type.
|
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.
|
ObjectIdInfo |
findObjectReferenceInfo(Annotated ann,
ObjectIdInfo objectIdInfo)
Method for figuring out additional properties of an Object Identity reference
|
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).
|
JsonPOJOBuilder.Value |
findPOJOBuilderConfig(AnnotatedClass ac) |
String[] |
findPropertiesToIgnore(Annotated ac)
Deprecated.
Since 2.6, use variant that takes second argument.
|
String[] |
findPropertiesToIgnore(Annotated ac,
boolean forSerialization)
Deprecated.
Since 2.8, use
findPropertyIgnorals(com.fasterxml.jackson.databind.introspect.Annotated) instead |
JsonProperty.Access |
findPropertyAccess(Annotated ann)
Method for finding optional access definition for a property, annotated
on one of its accessors.
|
List<PropertyName> |
findPropertyAliases(Annotated ann)
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.
|
String |
findPropertyDefaultValue(Annotated ann)
Method for finding suggested default value (as simple textual serialization)
for the property.
|
String |
findPropertyDescription(Annotated ann)
Method used to check whether specified property member (accessor
or mutator) defines human-readable description to use for documentation.
|
JsonIgnoreProperties.Value |
findPropertyIgnorals(Annotated ac)
Method for finding information about properties to ignore either by
name, or by more general specification ("ignore all unknown").
|
JsonInclude.Value |
findPropertyInclusion(Annotated a)
Method for checking inclusion criteria for a type (Class) or property (yes, method
name is bit unfortunate -- not just for properties!).
|
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.
|
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.ReferenceProperty |
findReferenceType(AnnotatedMember member)
Method for checking if given member indicates that it is part
of a reference (parent/child).
|
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.
|
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). |
Class<?> |
findSerializationContentType(Annotated am,
JavaType baseType)
|
Object |
findSerializationConverter(Annotated a)
Method for finding
Converter that annotated entity
(property or class) has indicated to be used as part of
serialization. |
JsonInclude.Include |
findSerializationInclusion(Annotated a,
JsonInclude.Include defValue)
Deprecated.
Since 2.7 Use
findPropertyInclusion(com.fasterxml.jackson.databind.introspect.Annotated) instead |
JsonInclude.Include |
findSerializationInclusionForContent(Annotated a,
JsonInclude.Include defValue)
Deprecated.
Since 2.7 Use
findPropertyInclusion(com.fasterxml.jackson.databind.introspect.Annotated) instead |
Class<?> |
findSerializationKeyType(Annotated am,
JavaType baseType)
|
String[] |
findSerializationPropertyOrder(AnnotatedClass ac)
Method for accessing defined property serialization order (which may be
partial).
|
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
|
Class<?> |
findSerializationType(Annotated a)
|
JsonSerialize.Typing |
findSerializationTyping(Annotated a)
Method for accessing declared typing mode annotated (if any).
|
Object |
findSerializer(Annotated am)
Method for getting a serializer definition on specified method
or field.
|
JsonSetter.Value |
findSetterInfo(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).
|
String |
findTypeName(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.
|
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.
|
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. |
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.
|
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.
|
Boolean |
hasAnyGetter(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.
|
boolean |
hasAnyGetterAnnotation(AnnotatedMethod am)
Deprecated.
Since 2.9 Use
hasAnyGetter(com.fasterxml.jackson.databind.introspect.Annotated) instead |
Boolean |
hasAnySetter(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.
|
boolean |
hasAnySetterAnnotation(AnnotatedMethod am)
Deprecated.
Since 2.9 use
hasAnySetter(com.fasterxml.jackson.databind.introspect.Annotated) instead. |
Boolean |
hasAsValue(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.
|
boolean |
hasAsValueAnnotation(AnnotatedMethod am)
Deprecated.
Since 2.9 Use
hasAsValue(Annotated) instead. |
boolean |
hasCreatorAnnotation(Annotated a)
Deprecated.
|
boolean |
hasIgnoreMarker(AnnotatedMember m)
Method called to check whether given property is marked to
be ignored.
|
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.
|
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.
|
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.
|
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.
|
static AnnotationIntrospector |
nopInstance()
Factory method for accessing "no operation" implementation
of introspector: instance that will never find any annotation-based
configuration.
|
static AnnotationIntrospector |
pair(AnnotationIntrospector a1,
AnnotationIntrospector a2) |
JavaType |
refineDeserializationType(MapperConfig<?> config,
Annotated a,
JavaType baseType)
Method called to find out possible type refinements to use
for deserialization.
|
JavaType |
refineSerializationType(MapperConfig<?> config,
Annotated a,
JavaType baseType)
Method called to find out possible type refinements to use
for deserialization, including not just value itself but
key and/or content type, if type has those.
|
AnnotatedMethod |
resolveSetterConflict(MapperConfig<?> config,
AnnotatedMethod setter1,
AnnotatedMethod setter2)
Method called in cases where a class has two methods eligible to be used
for the same logical property, and default logic is not enough to figure
out clear precedence.
|
abstract Version |
version()
Method called to detect version of the component that implements this interface;
returned version should never be null, but may return specific "not available"
instance (see
Version for details). |
public static AnnotationIntrospector nopInstance()
public static AnnotationIntrospector pair(AnnotationIntrospector a1, AnnotationIntrospector a2)
public Collection<AnnotationIntrospector> allIntrospectors()
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.
public Collection<AnnotationIntrospector> allIntrospectors(Collection<AnnotationIntrospector> result)
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.
public abstract Version version()
Versioned
Version
for details).public boolean isAnnotationBundle(Annotation ann)
public ObjectIdInfo findObjectIdInfo(Annotated ann)
public ObjectIdInfo findObjectReferenceInfo(Annotated ann, ObjectIdInfo objectIdInfo)
public PropertyName findRootName(AnnotatedClass ac)
NOTE: method signature changed in 2.1, to return PropertyName
instead of String.
public JsonIgnoreProperties.Value findPropertyIgnorals(Annotated ac)
findPropertiesToIgnore(Annotated, boolean)
and
findIgnoreUnknownProperties(AnnotatedClass)
.public Boolean isIgnorableType(AnnotatedClass ac)
ac
- Type to checkpublic Object findFilterId(Annotated ann)
public Object findNamingStrategy(AnnotatedClass ac)
PropertyNamingStrategy
for given
class, if any specified by annotations; and if so, either return
a PropertyNamingStrategy
instance, or Class to use for
creating instancePropertyNamingStrategy
, if one
is specified for given class; null if not.public String findClassDescription(AnnotatedClass ac)
@Deprecated public String[] findPropertiesToIgnore(Annotated ac, boolean forSerialization)
findPropertyIgnorals(com.fasterxml.jackson.databind.introspect.Annotated)
insteadforSerialization
- True if requesting properties to ignore for serialization;
false if for deserialization@Deprecated public String[] findPropertiesToIgnore(Annotated ac)
@Deprecated public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
findPropertyIgnorals(com.fasterxml.jackson.databind.introspect.Annotated)
insteadpublic VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)
public TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)
findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
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 foundpublic TypeResolverBuilder<?> findPropertyTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType baseType)
findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
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 foundpublic TypeResolverBuilder<?> findPropertyContentTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType containerType)
findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
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)public List<NamedType> findSubtypes(Annotated a)
a
- Annotated entity (class, field/method) to check for annotationspublic String findTypeName(AnnotatedClass ac)
ac
- Class to check for type name annotationspublic Boolean isTypeId(AnnotatedMember member)
public AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
public NameTransformer findUnwrappingNameTransformer(AnnotatedMember member)
public boolean hasIgnoreMarker(AnnotatedMember m)
public JacksonInject.Value findInjectableValue(AnnotatedMember m)
InjectableValues
); often a simple String
id is used.m
- Member to checkpublic Boolean hasRequiredMarker(AnnotatedMember m)
public Class<?>[] findViews(Annotated a)
Since 2.9 this method may also be called to find "default view(s)" for
AnnotatedClass
a
- Annotated property (represented by a method, field or ctor parameter)Object.class
)public JsonFormat.Value findFormat(Annotated memberOrClass)
public PropertyName findWrapperName(Annotated ann)
PropertyName.USE_DEFAULT
to indicate that no wrapper element should be used.public String findPropertyDefaultValue(Annotated ann)
public String findPropertyDescription(Annotated ann)
public Integer findPropertyIndex(Annotated ann)
public String findImplicitPropertyName(AnnotatedMember member)
public List<PropertyName> findPropertyAliases(Annotated ann)
public JsonProperty.Access findPropertyAccess(Annotated ann)
public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config, AnnotatedMethod setter1, AnnotatedMethod setter2)
@Deprecated public Object findInjectableValueId(AnnotatedMember m)
findInjectableValue(com.fasterxml.jackson.databind.introspect.AnnotatedMember)
insteadpublic Object findSerializer(Annotated am)
JsonSerializer
) or Class (of type
Class<JsonSerializer>
); if value of different
type is returned, a runtime exception may be thrown by caller.public Object findKeySerializer(Annotated am)
Map
property.
Type of definition is either instance (of type
JsonSerializer
) or Class (of type
Class<JsonSerializer>
); if value of different
type is returned, a runtime exception may be thrown by caller.public Object findContentSerializer(Annotated am)
Collection
, array
or Map
property.
Type of definition is either instance (of type
JsonSerializer
) or Class (of type
Class<JsonSerializer>
); if value of different
type is returned, a runtime exception may be thrown by caller.public Object findNullSerializer(Annotated am)
public JsonSerialize.Typing findSerializationTyping(Annotated a)
public Object findSerializationConverter(Annotated a)
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.
a
- Annotated property (field, method) or class to check for
annotationspublic Object findSerializationContentConverter(AnnotatedMember a)
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)
a
- Annotated property (field, method) to check.public JsonInclude.Value findPropertyInclusion(Annotated a)
@Deprecated public JsonInclude.Include findSerializationInclusion(Annotated a, JsonInclude.Include defValue)
findPropertyInclusion(com.fasterxml.jackson.databind.introspect.Annotated)
insteadNote 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.
@Deprecated public JsonInclude.Include findSerializationInclusionForContent(Annotated a, JsonInclude.Include defValue)
findPropertyInclusion(com.fasterxml.jackson.databind.introspect.Annotated)
insteadMap
property
are to be included during serialization or not.
NOTE: this is NOT called for POJO properties, or array/Collection elements.public JavaType refineSerializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException
JsonMappingException
@Deprecated public Class<?> findSerializationType(Annotated a)
@Deprecated public Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
@Deprecated public Class<?> findSerializationContentType(Annotated am, JavaType baseType)
public String[] findSerializationPropertyOrder(AnnotatedClass ac)
public Boolean findSerializationSortAlphabetically(Annotated ann)
public void findAndAddVirtualProperties(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties)
public PropertyName findNameForSerialization(Annotated a)
PropertyName.USE_DEFAULT
, which means "use default heuristics").a
- Property accessor to checkpublic Boolean hasAsValue(Annotated a)
Boolean.TRUE
if such annotation is found and is not disabled;
Boolean.FALSE
if disabled annotation (block) is found (to indicate
accessor is definitely NOT to be used "as value"); or `null` if no
information found.public Boolean hasAnyGetter(Annotated a)
public String[] findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names)
Enum
values
have explicitly defined name. Method will overwrite entries in incoming names
array with explicit names found, if any, leaving other entries unmodified.
Default implementation will simply delegate to findEnumValue(java.lang.Enum<?>)
, which is close
enough, although unfortunately NOT 100% equivalent (as it will also consider name()
to give explicit value).
public Enum<?> findDefaultEnumValue(Class<Enum<?>> enumCls)
enumCls
- The Enum class to scan for the default value.@Deprecated public String findEnumValue(Enum<?> value)
findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[])
instead because this method
does not properly handle override settings (defaults to enum.name
without indicating whether that is explicit or not), and is inefficient to
call one-by-one.@Deprecated public boolean hasAsValueAnnotation(AnnotatedMethod am)
hasAsValue(Annotated)
instead.@Deprecated public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
hasAnyGetter(com.fasterxml.jackson.databind.introspect.Annotated)
insteadpublic Object findDeserializer(Annotated am)
JsonDeserializer
) or Class (of type
Class<JsonDeserializer>
); if value of different
type is returned, a runtime exception may be thrown by caller.public Object findKeyDeserializer(Annotated am)
Map
property.
Type of definition is either instance (of type
JsonDeserializer
) or Class (of type
Class<JsonDeserializer>
); if value of different
type is returned, a runtime exception may be thrown by caller.public Object findContentDeserializer(Annotated am)
Collection
, array
or
Map
property.
Type of definition is either instance (of type
JsonDeserializer
) or Class (of type
Class<JsonDeserializer>
); if value of different
type is returned, a runtime exception may be thrown by caller.public Object findDeserializationConverter(Annotated a)
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.
a
- Annotated property (field, method) or class to check for
annotationspublic Object findDeserializationContentConverter(AnnotatedMember a)
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)
a
- Annotated property (field, method) to check.public JavaType refineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException
JsonMappingException
@Deprecated public Class<?> findDeserializationType(Annotated am, JavaType baseType)
refineDeserializationType(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.jackson.databind.introspect.Annotated, com.fasterxml.jackson.databind.JavaType)
insteadbaseType
- Assumed type before considering annotations@Deprecated public Class<?> findDeserializationKeyType(Annotated am, JavaType baseKeyType)
refineDeserializationType(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.jackson.databind.introspect.Annotated, com.fasterxml.jackson.databind.JavaType)
insteadMap
types.baseKeyType
- Assumed key type before considering annotations@Deprecated public Class<?> findDeserializationContentType(Annotated am, JavaType baseContentType)
refineDeserializationType(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.jackson.databind.introspect.Annotated, com.fasterxml.jackson.databind.JavaType)
insteadbaseContentType
- Assumed content (value) type before considering annotationspublic Object findValueInstantiator(AnnotatedClass ac)
ValueInstantiator
to use for given
type (class): return value can either be an instance of
instantiator, or class of instantiator to create.public Class<?> findPOJOBuilder(AnnotatedClass ac)
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.
public JsonPOJOBuilder.Value findPOJOBuilderConfig(AnnotatedClass ac)
public PropertyName findNameForDeserialization(Annotated a)
PropertyName.USE_DEFAULT
, which means "use default heuristics").a
- Property accessor to checkpublic Boolean hasAnySetter(Annotated a)
public JsonSetter.Value findSetterInfo(Annotated a)
public Boolean findMergeInfo(Annotated a)
public JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated a)
JsonCreator.Mode
to use.
NOTE: caller needs to consider possibility of both `null` (no annotation found)
and JsonCreator.Mode.DISABLED
(annotation found,
but disabled); latter is necessary as marker in case multiple introspectors are chained,
as well as possibly as when using mix-in annotations.
config
- Configuration settings in effect (for serialization or deserialization)a
- Annotated accessor (usually constructor or static method) to check@Deprecated public boolean hasCreatorAnnotation(Annotated a)
findCreatorAnnotation(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.jackson.databind.introspect.Annotated)
instead.@Deprecated public JsonCreator.Mode findCreatorBinding(Annotated a)
findCreatorAnnotation(com.fasterxml.jackson.databind.cfg.MapperConfig<?>, com.fasterxml.jackson.databind.introspect.Annotated)
instead.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).@Deprecated public boolean hasAnySetterAnnotation(AnnotatedMethod am)
hasAnySetter(com.fasterxml.jackson.databind.introspect.Annotated)
instead.protected <A extends Annotation> A _findAnnotation(Annotated annotated, Class<A> annoClass)
Default implementation is simply:
return annotated.getAnnotation(annoClass);
protected boolean _hasAnnotation(Annotated annotated, Class<? extends Annotation> annoClass)
Default implementation is simply:
return annotated.hasAnnotation(annoClass);
protected boolean _hasOneOf(Annotated annotated, Class<? extends Annotation>[] annoClasses)
Copyright © 2018 JBoss by Red Hat. All rights reserved.