public class AnnotationIntrospectorPair extends AnnotationIntrospector implements Serializable
An obvious consequence of priority is that it is easy to construct longer chains of introspectors by linking multiple pairs. Currently most likely combination is that of using the default Jackson provider, along with JAXB annotation introspector.
Note: up until 2.0, this class was an inner class of
AnnotationIntrospector
; moved here for convenience.
AnnotationIntrospector.ReferenceProperty
Modifier and Type | Field and Description |
---|---|
protected AnnotationIntrospector |
_primary |
protected AnnotationIntrospector |
_secondary |
Constructor and Description |
---|
AnnotationIntrospectorPair(AnnotationIntrospector p,
AnnotationIntrospector s) |
Modifier and Type | Method and Description |
---|---|
protected Object |
_explicitClassOrOb(Object maybeCls,
Class<?> implicit) |
protected boolean |
_isExplicitClassOrOb(Object maybeCls,
Class<?> implicit) |
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.
|
static AnnotationIntrospector |
create(AnnotationIntrospector primary,
AnnotationIntrospector secondary)
Helper method for constructing a Pair from two given introspectors (if
neither is null); or returning non-null introspector if one is null
(and return just null if both are null)
|
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 a)
Method for getting a serializer definition for content (values) of
associated
Collection , array or Map property. |
com.fasterxml.jackson.annotation.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. |
com.fasterxml.jackson.annotation.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)
Deprecated.
|
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)
Deprecated.
|
Class<?> |
findDeserializationType(Annotated am,
JavaType baseType)
Deprecated.
|
Object |
findDeserializer(Annotated a)
Method for getting a deserializer definition on specified method
or field.
|
void |
findEnumAliases(Class<?> enumType,
Enum<?>[] enumValues,
String[][] aliases)
Method that is related to
AnnotationIntrospector.findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[]) but is called to check if
there are alternative names (aliased) that can be accepted for entries, in
addition to primary names introspected earlier. |
String |
findEnumValue(Enum<?> value)
Deprecated.
|
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.
|
com.fasterxml.jackson.annotation.JsonFormat.Value |
findFormat(Annotated ann)
Method for finding format annotations for property or class.
|
Boolean |
findIgnoreUnknownProperties(AnnotatedClass ac)
Deprecated.
|
String |
findImplicitPropertyName(AnnotatedMember ann)
Method for finding implicit name for a property that given annotated
member (field, method, creator parameter) may represent.
|
com.fasterxml.jackson.annotation.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.
|
Object |
findKeyDeserializer(Annotated a)
Method for getting a deserializer definition for keys of
associated
Map property. |
Object |
findKeySerializer(Annotated a)
Method for getting a serializer definition for keys of associated
java.util.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 a)
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,
boolean forSerialization)
Deprecated.
|
com.fasterxml.jackson.annotation.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 baseType)
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.
|
com.fasterxml.jackson.annotation.JsonIgnoreProperties.Value |
findPropertyIgnoralByName(MapperConfig<?> config,
Annotated ann)
Method for finding information about properties to ignore either by
name, or by more general specification ("ignore all unknown").
|
com.fasterxml.jackson.annotation.JsonIgnoreProperties.Value |
findPropertyIgnorals(Annotated a)
Deprecated.
|
com.fasterxml.jackson.annotation.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!).
|
com.fasterxml.jackson.annotation.JsonIncludeProperties.Value |
findPropertyInclusionByName(MapperConfig<?> config,
Annotated a)
Method for finding information about names of properties to included.
|
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 |
findRenameByField(MapperConfig<?> config,
AnnotatedField f,
PropertyName implName)
Method called on fields that are eligible candidates for properties
(that is, non-static member fields), but not necessarily selected (may
or may not be visible), to let fields affect name linking.
|
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)
Deprecated.
|
Object |
findSerializationConverter(Annotated a)
Method for finding
Converter that annotated entity
(property or class) has indicated to be used as part of
serialization. |
com.fasterxml.jackson.annotation.JsonInclude.Include |
findSerializationInclusion(Annotated a,
com.fasterxml.jackson.annotation.JsonInclude.Include defValue)
Deprecated.
|
com.fasterxml.jackson.annotation.JsonInclude.Include |
findSerializationInclusionForContent(Annotated a,
com.fasterxml.jackson.annotation.JsonInclude.Include defValue)
Deprecated.
|
Class<?> |
findSerializationKeyType(Annotated am,
JavaType baseType)
Deprecated.
|
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)
Deprecated.
|
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.
|
com.fasterxml.jackson.annotation.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.
|
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.
|
Boolean |
hasAsKey(MapperConfig<?> config,
Annotated a)
Method for checking whether given method has an annotation
that suggests the return value of annotated field or method
should be used as "the key" of the object instance; usually
serialized as a primitive value such as String or number.
|
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.
|
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.
|
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.
|
com.fasterxml.jackson.core.Version |
version() |
_findAnnotation, _hasAnnotation, _hasOneOf, nopInstance, pair
protected final AnnotationIntrospector _primary
protected final AnnotationIntrospector _secondary
public AnnotationIntrospectorPair(AnnotationIntrospector p, AnnotationIntrospector s)
public com.fasterxml.jackson.core.Version version()
version
in interface com.fasterxml.jackson.core.Versioned
version
in class AnnotationIntrospector
public static AnnotationIntrospector create(AnnotationIntrospector primary, AnnotationIntrospector secondary)
public Collection<AnnotationIntrospector> allIntrospectors()
AnnotationIntrospector
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
in class AnnotationIntrospector
public Collection<AnnotationIntrospector> allIntrospectors(Collection<AnnotationIntrospector> result)
AnnotationIntrospector
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.
allIntrospectors
in class AnnotationIntrospector
result
- Container to add introspectors toCollection
filled with introspectors as explained
abovepublic boolean isAnnotationBundle(Annotation ann)
AnnotationIntrospector
isAnnotationBundle
in class AnnotationIntrospector
ann
- Annotated entity to introspectpublic PropertyName findRootName(AnnotatedClass ac)
AnnotationIntrospector
NOTE: method signature changed in 2.1, to return PropertyName
instead of String.
findRootName
in class AnnotationIntrospector
ac
- Annotated class to introspectnull
if notpublic com.fasterxml.jackson.annotation.JsonIgnoreProperties.Value findPropertyIgnoralByName(MapperConfig<?> config, Annotated ann)
AnnotationIntrospector
AnnotationIntrospector.findPropertiesToIgnore(Annotated, boolean)
and
AnnotationIntrospector.findIgnoreUnknownProperties(AnnotatedClass)
.findPropertyIgnoralByName
in class AnnotationIntrospector
config
- Configuration settings in effect (for serialization or deserialization)ann
- Annotated entity (Class, Accessor) to introspectJsonIgnoreProperties.Value.empty()
for defaults (should not return null
)public com.fasterxml.jackson.annotation.JsonIncludeProperties.Value findPropertyInclusionByName(MapperConfig<?> config, Annotated a)
AnnotationIntrospector
findPropertyInclusionByName
in class AnnotationIntrospector
config
- Configuration settings in effect (for serialization or deserialization)a
- Annotated entity (Class, Accessor) to introspectJsonIncludeProperties.Value.all()
for defaults (should not return null
)public Boolean isIgnorableType(AnnotatedClass ac)
AnnotationIntrospector
isIgnorableType
in class AnnotationIntrospector
ac
- Annotated class to introspectpublic Object findFilterId(Annotated ann)
AnnotationIntrospector
findFilterId
in class AnnotationIntrospector
ann
- Annotated entity to introspectpublic Object findNamingStrategy(AnnotatedClass ac)
AnnotationIntrospector
PropertyNamingStrategy
for given
class, if any specified by annotations; and if so, either return
a PropertyNamingStrategy
instance, or Class to use for
creating instancefindNamingStrategy
in class AnnotationIntrospector
ac
- Annotated class to introspectPropertyNamingStrategy
, if one
is specified for given class; null if not.public String findClassDescription(AnnotatedClass ac)
AnnotationIntrospector
findClassDescription
in class AnnotationIntrospector
ac
- Annotated class to introspect@Deprecated public String[] findPropertiesToIgnore(Annotated ac, boolean forSerialization)
findPropertiesToIgnore
in class AnnotationIntrospector
ac
- Annotated class to introspectforSerialization
- True if requesting properties to ignore for serialization;
false if for deserialization@Deprecated public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
AnnotationIntrospector
findIgnoreUnknownProperties
in class AnnotationIntrospector
ac
- Annotated class to introspect@Deprecated public com.fasterxml.jackson.annotation.JsonIgnoreProperties.Value findPropertyIgnorals(Annotated a)
findPropertyIgnorals
in class AnnotationIntrospector
a
- Annotated class to introspectJsonIgnoreProperties.Value.empty()
for defaults (should not return null
)public VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)
AnnotationIntrospector
findAutoDetectVisibility
in class AnnotationIntrospector
ac
- Annotated class to introspectchecker
- Default visibility settings in effect before any overridepublic TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)
AnnotationIntrospector
AnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
findTypeResolver
in class AnnotationIntrospector
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)
AnnotationIntrospector
AnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
findPropertyTypeResolver
in class AnnotationIntrospector
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 baseType)
AnnotationIntrospector
AnnotationIntrospector.findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
findPropertyContentTypeResolver
in class AnnotationIntrospector
config
- Configuration settings in effect (for serialization or deserialization)am
- Annotated member (field or method) to check for annotationsbaseType
- Type of property for which resolver is to be found (must be a container type)public List<NamedType> findSubtypes(Annotated a)
AnnotationIntrospector
findSubtypes
in class AnnotationIntrospector
a
- Annotated entity (class, field/method) to check for annotationsnull
if nonepublic String findTypeName(AnnotatedClass ac)
AnnotationIntrospector
findTypeName
in class AnnotationIntrospector
ac
- Class to check for type name annotationsnull
if nonepublic AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
AnnotationIntrospector
findReferenceType
in class AnnotationIntrospector
public NameTransformer findUnwrappingNameTransformer(AnnotatedMember member)
AnnotationIntrospector
findUnwrappingNameTransformer
in class AnnotationIntrospector
public com.fasterxml.jackson.annotation.JacksonInject.Value findInjectableValue(AnnotatedMember m)
AnnotationIntrospector
InjectableValues
); often a simple String
id is used.findInjectableValue
in class AnnotationIntrospector
m
- Member to checkpublic boolean hasIgnoreMarker(AnnotatedMember m)
AnnotationIntrospector
hasIgnoreMarker
in class AnnotationIntrospector
public Boolean hasRequiredMarker(AnnotatedMember m)
AnnotationIntrospector
hasRequiredMarker
in class AnnotationIntrospector
@Deprecated public Object findInjectableValueId(AnnotatedMember m)
findInjectableValueId
in class AnnotationIntrospector
public Object findSerializer(Annotated am)
AnnotationIntrospector
JsonSerializer
)
or Class (of Class<JsonSerializer>
implementation subtype);
if value of different type is returned, a runtime exception may be thrown by caller.findSerializer
in class AnnotationIntrospector
public Object findKeySerializer(Annotated a)
AnnotationIntrospector
java.util.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.findKeySerializer
in class AnnotationIntrospector
public Object findContentSerializer(Annotated a)
AnnotationIntrospector
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.findContentSerializer
in class AnnotationIntrospector
public Object findNullSerializer(Annotated a)
AnnotationIntrospector
findNullSerializer
in class AnnotationIntrospector
@Deprecated public com.fasterxml.jackson.annotation.JsonInclude.Include findSerializationInclusion(Annotated a, com.fasterxml.jackson.annotation.JsonInclude.Include defValue)
AnnotationIntrospector
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.
findSerializationInclusion
in class AnnotationIntrospector
@Deprecated public com.fasterxml.jackson.annotation.JsonInclude.Include findSerializationInclusionForContent(Annotated a, com.fasterxml.jackson.annotation.JsonInclude.Include defValue)
AnnotationIntrospector
Map
property
are to be included during serialization or not.
NOTE: this is NOT called for POJO properties, or array/Collection elements.findSerializationInclusionForContent
in class AnnotationIntrospector
public com.fasterxml.jackson.annotation.JsonInclude.Value findPropertyInclusion(Annotated a)
AnnotationIntrospector
findPropertyInclusion
in class AnnotationIntrospector
public JsonSerialize.Typing findSerializationTyping(Annotated a)
AnnotationIntrospector
findSerializationTyping
in class AnnotationIntrospector
public Object findSerializationConverter(Annotated a)
AnnotationIntrospector
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.
findSerializationConverter
in class AnnotationIntrospector
a
- Annotated property (field, method) or class to check for
annotationspublic Object findSerializationContentConverter(AnnotatedMember a)
AnnotationIntrospector
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 AnnotationIntrospector.findSerializationConverter(com.fasterxml.jackson.databind.introspect.Annotated)
findSerializationContentConverter
in class AnnotationIntrospector
a
- Annotated property (field, method) to check.public Class<?>[] findViews(Annotated a)
AnnotationIntrospector
Since 2.9 this method may also be called to find "default view(s)" for
AnnotatedClass
findViews
in class AnnotationIntrospector
a
- Annotated property (represented by a method, field or ctor parameter)Object.class
)public Boolean isTypeId(AnnotatedMember member)
AnnotationIntrospector
isTypeId
in class AnnotationIntrospector
member
- Annotated accessor (field/method/constructor parameter) to check for annotationsnull
if no information found.public ObjectIdInfo findObjectIdInfo(Annotated ann)
AnnotationIntrospector
findObjectIdInfo
in class AnnotationIntrospector
ann
- Annotated entity to introspectnull
otherwise.public ObjectIdInfo findObjectReferenceInfo(Annotated ann, ObjectIdInfo objectIdInfo)
AnnotationIntrospector
findObjectReferenceInfo
in class AnnotationIntrospector
ann
- Annotated entity to introspectobjectIdInfo
- (optional) Base Object Id information, if any; null
if noneObjectIdInfo
augmented with possible additional informationpublic com.fasterxml.jackson.annotation.JsonFormat.Value findFormat(Annotated ann)
AnnotationIntrospector
findFormat
in class AnnotationIntrospector
public PropertyName findWrapperName(Annotated ann)
AnnotationIntrospector
findWrapperName
in class AnnotationIntrospector
PropertyName.USE_DEFAULT
to indicate that no wrapper element should be used.public String findPropertyDefaultValue(Annotated ann)
AnnotationIntrospector
findPropertyDefaultValue
in class AnnotationIntrospector
public String findPropertyDescription(Annotated ann)
AnnotationIntrospector
findPropertyDescription
in class AnnotationIntrospector
public Integer findPropertyIndex(Annotated ann)
AnnotationIntrospector
findPropertyIndex
in class AnnotationIntrospector
public String findImplicitPropertyName(AnnotatedMember ann)
AnnotationIntrospector
findImplicitPropertyName
in class AnnotationIntrospector
public List<PropertyName> findPropertyAliases(Annotated ann)
AnnotationIntrospector
findPropertyAliases
in class AnnotationIntrospector
public com.fasterxml.jackson.annotation.JsonProperty.Access findPropertyAccess(Annotated ann)
AnnotationIntrospector
findPropertyAccess
in class AnnotationIntrospector
public AnnotatedMethod resolveSetterConflict(MapperConfig<?> config, AnnotatedMethod setter1, AnnotatedMethod setter2)
AnnotationIntrospector
resolveSetterConflict
in class AnnotationIntrospector
public PropertyName findRenameByField(MapperConfig<?> config, AnnotatedField f, PropertyName implName)
AnnotationIntrospector
Specific example (and initial use case is for support Kotlin's "is getter"
matching (see
Kotling Interop
for details), in which field like 'isOpen
' would have implicit name of
"isOpen", match getter getOpen()
and setter setOpen(boolean)
,
but use logical external name of "isOpen" (and not implicit name of getter/setter, "open"!).
To achieve this, field implicit name needs to remain "isOpen" but this method needs
to return name PropertyName.construct("open")
: doing so will "pull in" getter
and/or setter, and rename them as "isOpen".
findRenameByField
in class AnnotationIntrospector
config
- Effective mapper configuration in usef
- Field to checkimplName
- Implicit name of the field; usually name of field itself but not always,
used as the target name for accessors to rename.null
to indicate
no renamingpublic JavaType refineSerializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException
AnnotationIntrospector
refineSerializationType
in class AnnotationIntrospector
JsonMappingException
@Deprecated public Class<?> findSerializationType(Annotated a)
findSerializationType
in class AnnotationIntrospector
@Deprecated public Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
findSerializationKeyType
in class AnnotationIntrospector
@Deprecated public Class<?> findSerializationContentType(Annotated am, JavaType baseType)
findSerializationContentType
in class AnnotationIntrospector
public String[] findSerializationPropertyOrder(AnnotatedClass ac)
AnnotationIntrospector
findSerializationPropertyOrder
in class AnnotationIntrospector
public Boolean findSerializationSortAlphabetically(Annotated ann)
AnnotationIntrospector
findSerializationSortAlphabetically
in class AnnotationIntrospector
public void findAndAddVirtualProperties(MapperConfig<?> config, AnnotatedClass ac, List<BeanPropertyWriter> properties)
AnnotationIntrospector
findAndAddVirtualProperties
in class AnnotationIntrospector
public PropertyName findNameForSerialization(Annotated a)
AnnotationIntrospector
PropertyName.USE_DEFAULT
, which means "use default heuristics").findNameForSerialization
in class AnnotationIntrospector
a
- Property accessor to checkpublic Boolean hasAsKey(MapperConfig<?> config, Annotated a)
AnnotationIntrospector
hasAsKey
in class AnnotationIntrospector
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 hasAsValue(Annotated a)
AnnotationIntrospector
hasAsValue
in class AnnotationIntrospector
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)
AnnotationIntrospector
hasAnyGetter
in class AnnotationIntrospector
a
- Annotated entity to checkpublic String[] findEnumValues(Class<?> enumType, Enum<?>[] enumValues, String[] names)
AnnotationIntrospector
Enum
values
have explicitly defined name. Method will overwrite entries in incoming names
array with explicit names found, if any, leaving other entries unmodified.findEnumValues
in class AnnotationIntrospector
enumType
- Type of EnumerationenumValues
- Values of enumerationnames
- Matching declared names of enumeration values (with indexes
matching enumValues
entries)names
passed as argument)public void findEnumAliases(Class<?> enumType, Enum<?>[] enumValues, String[][] aliases)
AnnotationIntrospector
AnnotationIntrospector.findEnumValues(java.lang.Class<?>, java.lang.Enum<?>[], java.lang.String[])
but is called to check if
there are alternative names (aliased) that can be accepted for entries, in
addition to primary names introspected earlier.
If so, these aliases should be returned in aliases
List
passed
as argument (and initialized for proper size by caller).findEnumAliases
in class AnnotationIntrospector
enumType
- Type of EnumerationenumValues
- Values of enumerationaliases
- (in/out) Pre-allocated array where aliases found, if any, may be
added (in indexes matching those of enumValues
)public Enum<?> findDefaultEnumValue(Class<Enum<?>> enumCls)
AnnotationIntrospector
findDefaultEnumValue
in class AnnotationIntrospector
enumCls
- The Enum class to scan for the default value@Deprecated public String findEnumValue(Enum<?> value)
AnnotationIntrospector
findEnumValue
in class AnnotationIntrospector
value
- Enum value to introspect@Deprecated public boolean hasAsValueAnnotation(AnnotatedMethod am)
hasAsValueAnnotation
in class AnnotationIntrospector
am
- Annotated method to check@Deprecated public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
hasAnyGetterAnnotation
in class AnnotationIntrospector
am
- Annotated method to checkpublic Object findDeserializer(Annotated a)
AnnotationIntrospector
JsonDeserializer
)
or Class (of type Class&<JsonDeserializer>
);
type is returned, a runtime exception may be thrown by caller.findDeserializer
in class AnnotationIntrospector
public Object findKeyDeserializer(Annotated a)
AnnotationIntrospector
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.findKeyDeserializer
in class AnnotationIntrospector
public Object findContentDeserializer(Annotated am)
AnnotationIntrospector
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.findContentDeserializer
in class AnnotationIntrospector
public Object findDeserializationConverter(Annotated a)
AnnotationIntrospector
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.
findDeserializationConverter
in class AnnotationIntrospector
a
- Annotated property (field, method) or class to check for
annotationspublic Object findDeserializationContentConverter(AnnotatedMember a)
AnnotationIntrospector
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 AnnotationIntrospector.findDeserializationConverter(com.fasterxml.jackson.databind.introspect.Annotated)
findDeserializationContentConverter
in class AnnotationIntrospector
a
- Annotated property (field, method) to check.public JavaType refineDeserializationType(MapperConfig<?> config, Annotated a, JavaType baseType) throws JsonMappingException
AnnotationIntrospector
refineDeserializationType
in class AnnotationIntrospector
JsonMappingException
@Deprecated public Class<?> findDeserializationType(Annotated am, JavaType baseType)
AnnotationIntrospector
findDeserializationType
in class AnnotationIntrospector
am
- Annotated entity to introspectbaseType
- Assumed type before considering annotations@Deprecated public Class<?> findDeserializationKeyType(Annotated am, JavaType baseKeyType)
AnnotationIntrospector
Map
types.findDeserializationKeyType
in class AnnotationIntrospector
am
- Annotated entity to introspectbaseKeyType
- Assumed key type before considering annotations@Deprecated public Class<?> findDeserializationContentType(Annotated am, JavaType baseContentType)
AnnotationIntrospector
findDeserializationContentType
in class AnnotationIntrospector
am
- Annotated entity to introspectbaseContentType
- Assumed content (value) type before considering annotationspublic Object findValueInstantiator(AnnotatedClass ac)
AnnotationIntrospector
ValueInstantiator
to use for given
type (class): return value can either be an instance of
instantiator, or class of instantiator to create.findValueInstantiator
in class AnnotationIntrospector
ac
- Annotated class to introspectValueInstantiator
instance to use, or
Class
of one to create; or null
if no annotations
found to indicate custom value instantiator.public Class<?> findPOJOBuilder(AnnotatedClass ac)
AnnotationIntrospector
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.
findPOJOBuilder
in class AnnotationIntrospector
ac
- Annotated class to introspectnull
if not.public JsonPOJOBuilder.Value findPOJOBuilderConfig(AnnotatedClass ac)
findPOJOBuilderConfig
in class AnnotationIntrospector
ac
- Annotated class to introspectnull
if not.public PropertyName findNameForDeserialization(Annotated a)
AnnotationIntrospector
PropertyName.USE_DEFAULT
, which means "use default heuristics").findNameForDeserialization
in class AnnotationIntrospector
a
- Annotated entity to checknull
if not.public Boolean hasAnySetter(Annotated a)
AnnotationIntrospector
hasAnySetter
in class AnnotationIntrospector
a
- Annotated entity to checkBoolean.TRUE
or Boolean.FALSE
if explicit
"any setter" marker found; null
otherwise.public com.fasterxml.jackson.annotation.JsonSetter.Value findSetterInfo(Annotated a)
AnnotationIntrospector
findSetterInfo
in class AnnotationIntrospector
a
- Annotated entity to checkJsonSetter.Value.empty()
if none (should not return null
)public Boolean findMergeInfo(Annotated a)
AnnotationIntrospector
findMergeInfo
in class AnnotationIntrospector
a
- Annotated entity to checkBoolean.TRUE
or Boolean.FALSE
if explicit
merge enable/disable found; null
otherwise.@Deprecated public boolean hasCreatorAnnotation(Annotated a)
AnnotationIntrospector
hasCreatorAnnotation
in class AnnotationIntrospector
a
- Annotated entity to check@Deprecated public com.fasterxml.jackson.annotation.JsonCreator.Mode findCreatorBinding(Annotated a)
AnnotationIntrospector
AnnotationIntrospector.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).findCreatorBinding
in class AnnotationIntrospector
a
- Annotated entity to checknull
if nonepublic com.fasterxml.jackson.annotation.JsonCreator.Mode findCreatorAnnotation(MapperConfig<?> config, Annotated a)
AnnotationIntrospector
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.
findCreatorAnnotation
in class AnnotationIntrospector
config
- Configuration settings in effect (for serialization or deserialization)a
- Annotated accessor (usually constructor or static method) to checknull
if none@Deprecated public boolean hasAnySetterAnnotation(AnnotatedMethod am)
hasAnySetterAnnotation
in class AnnotationIntrospector
am
- Annotated method to checktrue
if "any-setter" annotation was found; false
otherwiseCopyright © 2008–2021 FasterXML. All rights reserved.