public class JacksonAnnotationIntrospector extends AnnotationIntrospector
AnnotationIntrospector implementation that handles standard
Jackson annotations.AnnotationIntrospector.Pair, AnnotationIntrospector.ReferenceProperty| Constructor and Description |
|---|
JacksonAnnotationIntrospector() |
| Modifier and Type | Method and Description |
|---|---|
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 standard
TypeResolverBuilder
implementation. |
protected TypeResolverBuilder<?> |
_findTypeResolver(MapperConfig<?> config,
Annotated ann,
JavaType baseType)
Helper method called to construct and initialize instance of
TypeResolverBuilder
if given annotated element indicates one is needed. |
protected boolean |
_isIgnorable(Annotated a) |
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).
|
Boolean |
findCachability(AnnotatedClass ac)
Method that checks whether specified class has annotations
that indicate that it is (or is not) cachable.
|
Class<? extends JsonDeserializer<?>> |
findContentDeserializer(Annotated a)
Method for getting a deserializer definition for content (values) of
associated
Collection, array or
Map property. |
Class<? extends JsonSerializer<?>> |
findContentSerializer(Annotated a)
Method for getting a serializer definition for content (values) of
associated
Collection, array or Map property. |
String |
findDeserializablePropertyName(AnnotatedField af)
Method for checking whether given member field represent
a deserializable logical property; and if so, returns the
name of that property.
|
Class<?> |
findDeserializationContentType(Annotated am,
JavaType baseContentType,
String propName)
Method for accessing additional narrowing type definition that a
method can have, to define more specific content type to use;
content refers to Map values and Collection/array elements.
|
Class<?> |
findDeserializationKeyType(Annotated am,
JavaType baseKeyType,
String propName)
Method for accessing additional narrowing type definition that a
method can have, to define more specific key type to use.
|
Class<?> |
findDeserializationType(Annotated am,
JavaType baseType,
String propName)
Method for accessing annotated type definition that a
method can have, to be used as the type for serialization
instead of the runtime type.
|
Class<? extends JsonDeserializer<?>> |
findDeserializer(Annotated a)
Method for getting a deserializer definition on specified method
or field.
|
String |
findEnumValue(Enum<?> value)
Method for determining the String value to use for serializing
given enumeration entry; used when serializing enumerations
as Strings (the standard method).
|
Object |
findFilterId(AnnotatedClass ac)
Method for finding if annotated class has associated filter; and if so,
to return id that is used to locate filter.
|
String |
findGettablePropertyName(AnnotatedMethod am)
Method for checking whether given method has an annotation
that suggests property name associated with method that
may be a "getter".
|
Boolean |
findIgnoreUnknownProperties(AnnotatedClass ac)
Method for checking whether an annotation indicates that all unknown properties
|
Object |
findInjectableValueId(AnnotatedMember m)
Method called to find out whether given member expectes a value
to be injected, and if so, what is the identifier of the value
to use during injection.
|
Class<? extends KeyDeserializer> |
findKeyDeserializer(Annotated a)
Method for getting a deserializer definition for keys of
associated
Map property. |
Class<? extends JsonSerializer<?>> |
findKeySerializer(Annotated a)
Method for getting a serializer definition for keys of associated
Map property. |
String[] |
findPropertiesToIgnore(AnnotatedClass ac)
Method for finding list of properties to ignore for given class
(null is returned if not specified).
|
TypeResolverBuilder<?> |
findPropertyContentTypeResolver(MapperConfig<?> config,
AnnotatedMember am,
JavaType containerType)
Since 1.7, it is possible to use
JsonTypeInfo from a property too. |
String |
findPropertyNameForParam(AnnotatedParameter param)
Method for checking whether given set of annotations indicates
property name for associated parameter.
|
TypeResolverBuilder<?> |
findPropertyTypeResolver(MapperConfig<?> config,
AnnotatedMember am,
JavaType baseType)
Since 1.7, it is possible to use
JsonTypeInfo from a property too. |
AnnotationIntrospector.ReferenceProperty |
findReferenceType(AnnotatedMember member)
Note: defined as non-abstract to reduce fragility between
versions.
|
String |
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.
|
String |
findSerializablePropertyName(AnnotatedField af)
Method for checking whether given member field represent
a serializable logical property; and if so, returns the
name of that property.
|
Class<?> |
findSerializationContentType(Annotated am,
JavaType baseType)
Method for finding possible widening type definition that a property
value can have, to define less specific key type to use for serialization.
|
JsonSerialize.Inclusion |
findSerializationInclusion(Annotated a,
JsonSerialize.Inclusion defValue)
Method for checking whether given annotated entity (class, method,
field) defines which Bean/Map properties are to be included in
serialization.
|
Class<?> |
findSerializationKeyType(Annotated am,
JavaType baseType)
Method for finding possible widening type definition that a property
value can have, to define less specific key type to use for serialization.
|
String[] |
findSerializationPropertyOrder(AnnotatedClass ac)
Method for accessing defined property serialization order (which may be
partial).
|
Boolean |
findSerializationSortAlphabetically(AnnotatedClass ac)
Method for checking whether an annotation indicates that serialized properties
for which no explicit is defined should be alphabetically (lexicograpically)
ordered
|
Class<?> |
findSerializationType(Annotated am)
Method for accessing annotated type definition that a
method/field can have, to be used as the type for serialization
instead of the runtime type.
|
JsonSerialize.Typing |
findSerializationTyping(Annotated a)
Method for accessing declared typing mode annotated (if any).
|
Class<?>[] |
findSerializationViews(Annotated a)
Method for checking if annotated serializable property (represented by
field or getter method) has definitions for views it is to be included
in.
|
Object |
findSerializer(Annotated a)
Method for getting a serializer definition on specified method
or field.
|
String |
findSettablePropertyName(AnnotatedMethod am)
Method for checking whether given method has an annotation
that suggests property name associated with method that
may be a "setter".
|
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.
|
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. |
boolean |
hasAnyGetterAnnotation(AnnotatedMethod am)
Method for checking whether given method has an annotation
that suggests that the method is to serve as "any setter";
method to be used for accessing set of miscellaneous "extra"
properties, often bound with matching "any setter" method.
|
boolean |
hasAnySetterAnnotation(AnnotatedMethod am)
Method for checking whether given method has an annotation
that suggests that the method is to serve as "any setter";
method to be used for setting values of any properties for
which no dedicated setter method is found.
|
boolean |
hasAsValueAnnotation(AnnotatedMethod am)
Method for checking whether given method has an annotation
that suggests that the return value of annotated method
should be used as "the value" of the object instance; usually
serialized as a primitive value such as String or number.
|
boolean |
hasCreatorAnnotation(Annotated a)
Method for checking whether given annotated item (method, constructor)
has an annotation
that suggests that the method is a "creator" (aka factory)
method to be used for construct new instances of deserialized
values.
|
boolean |
hasIgnoreMarker(AnnotatedMember m)
Method called to check whether given property is marked to
be ignored; but NOT to determine if it should necessarily
be ignored, since that may depend on other factors.
|
boolean |
isHandled(Annotation ann)
Method called by framework to determine whether given annotation
is handled by this introspector.
|
boolean |
isIgnorableConstructor(AnnotatedConstructor c) |
boolean |
isIgnorableField(AnnotatedField f)
Method for checking whether there is an annotation that
indicates that given field should be ignored for all
operations (serialization, deserialization).
|
boolean |
isIgnorableMethod(AnnotatedMethod m)
Method for checking whether there is an annotation that
indicates that given method should be ignored for all
operations (serialization, deserialization).
|
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 |
shouldUnwrapProperty(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.
|
allIntrospectors, allIntrospectors, nopInstance, pairpublic boolean isHandled(Annotation ann)
AnnotationIntrospectorisHandled in class AnnotationIntrospectorpublic String findEnumValue(Enum<?> value)
AnnotationIntrospectorNOTE: implemented since 1.9.11, to make things work even when annotation introspection is disabled.
findEnumValue in class AnnotationIntrospectorpublic Boolean findCachability(AnnotatedClass ac)
AnnotationIntrospectorCurrently only used with deserializers, to determine whether provider should cache instances, and if no annotations are found, assumes non-cachable instances.
findCachability in class AnnotationIntrospectorpublic String findRootName(AnnotatedClass ac)
AnnotationIntrospectorfindRootName in class AnnotationIntrospectorpublic String[] findPropertiesToIgnore(AnnotatedClass ac)
AnnotationIntrospectorfindPropertiesToIgnore in class AnnotationIntrospectorpublic Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
AnnotationIntrospectorfindIgnoreUnknownProperties in class AnnotationIntrospectorpublic Boolean isIgnorableType(AnnotatedClass ac)
AnnotationIntrospectorisIgnorableType in class AnnotationIntrospectorac - Type to checkpublic Object findFilterId(AnnotatedClass ac)
AnnotationIntrospectorfindFilterId in class AnnotationIntrospectorpublic VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)
AnnotationIntrospectorfindAutoDetectVisibility in class AnnotationIntrospectorpublic AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
AnnotationIntrospectorfindReferenceType in class AnnotationIntrospectorpublic Boolean shouldUnwrapProperty(AnnotatedMember member)
AnnotationIntrospectorshouldUnwrapProperty in class AnnotationIntrospectorpublic boolean hasIgnoreMarker(AnnotatedMember m)
AnnotationIntrospector
Default implementation calls existing 'isIgnored' methods
such as AnnotationIntrospector.isIgnorableField(AnnotatedField) and
AnnotationIntrospector.isIgnorableMethod(AnnotatedMethod).
hasIgnoreMarker in class AnnotationIntrospectorpublic Object findInjectableValueId(AnnotatedMember m)
AnnotationIntrospectorInjectableValues); often a simple String
id is used.findInjectableValueId in class AnnotationIntrospectorm - Member to checkpublic TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)
AnnotationIntrospectorAnnotationIntrospector.findSubtypes(org.codehaus.jackson.map.introspect.Annotated)findTypeResolver in class AnnotationIntrospectorconfig - 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)
JsonTypeInfo from a property too.findPropertyTypeResolver in class AnnotationIntrospectorconfig - 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)
JsonTypeInfo from a property too.findPropertyContentTypeResolver in class AnnotationIntrospectorconfig - 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)
AnnotationIntrospectorfindSubtypes in class AnnotationIntrospectora - Annotated entity (class, field/method) to check for annotationspublic String findTypeName(AnnotatedClass ac)
AnnotationIntrospectorfindTypeName in class AnnotationIntrospectorac - Class to check for type name annotationspublic boolean isIgnorableMethod(AnnotatedMethod m)
AnnotationIntrospectorNote that this method should ONLY return true for such explicit ignoral cases; and not if method just happens not to be visible for annotation processor.
isIgnorableMethod in class AnnotationIntrospectorpublic boolean isIgnorableConstructor(AnnotatedConstructor c)
isIgnorableConstructor in class AnnotationIntrospectorpublic boolean isIgnorableField(AnnotatedField f)
AnnotationIntrospectorisIgnorableField in class AnnotationIntrospectorpublic Object findSerializer(Annotated a)
AnnotationIntrospectorJsonSerializer) or Class (of type
Class); if value of different
type is returned, a runtime exception may be thrown by caller.
Note: this variant was briefly deprecated for 1.7; should not be
findSerializer in class AnnotationIntrospectorpublic Class<? extends JsonSerializer<?>> findKeySerializer(Annotated a)
AnnotationIntrospectorMap property.
Type of definition is either instance (of type
JsonSerializer) or Class (of type
Class); if value of different
type is returned, a runtime exception may be thrown by caller.findKeySerializer in class AnnotationIntrospectorpublic Class<? extends JsonSerializer<?>> findContentSerializer(Annotated a)
AnnotationIntrospectorCollection, array or Map property.
Type of definition is either instance (of type
JsonSerializer) or Class (of type
Class); if value of different
type is returned, a runtime exception may be thrown by caller.findContentSerializer in class AnnotationIntrospectorpublic JsonSerialize.Inclusion findSerializationInclusion(Annotated a, JsonSerialize.Inclusion defValue)
AnnotationIntrospectorfindSerializationInclusion in class AnnotationIntrospectorpublic Class<?> findSerializationType(Annotated am)
AnnotationIntrospectorfindSerializationType in class AnnotationIntrospectorpublic Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
AnnotationIntrospectorMap types.findSerializationKeyType in class AnnotationIntrospectorpublic Class<?> findSerializationContentType(Annotated am, JavaType baseType)
AnnotationIntrospectorfindSerializationContentType in class AnnotationIntrospectorpublic JsonSerialize.Typing findSerializationTyping(Annotated a)
AnnotationIntrospectorfindSerializationTyping in class AnnotationIntrospectorpublic Class<?>[] findSerializationViews(Annotated a)
AnnotationIntrospectorfindSerializationViews in class AnnotationIntrospectora - Annotated serializable property (field or getter method)Object.class)public String[] findSerializationPropertyOrder(AnnotatedClass ac)
AnnotationIntrospectorfindSerializationPropertyOrder in class AnnotationIntrospectorpublic Boolean findSerializationSortAlphabetically(AnnotatedClass ac)
AnnotationIntrospectorfindSerializationSortAlphabetically in class AnnotationIntrospectorpublic String findGettablePropertyName(AnnotatedMethod am)
AnnotationIntrospectorfindGettablePropertyName in class AnnotationIntrospectorpublic boolean hasAsValueAnnotation(AnnotatedMethod am)
AnnotationIntrospectorhasAsValueAnnotation in class AnnotationIntrospectorpublic String findSerializablePropertyName(AnnotatedField af)
AnnotationIntrospectorfindSerializablePropertyName in class AnnotationIntrospectorpublic Class<? extends JsonDeserializer<?>> findDeserializer(Annotated a)
AnnotationIntrospectorJsonDeserializer) or Class (of type
Class); if value of different
type is returned, a runtime exception may be thrown by caller.
Note: this variant was briefly deprecated for 1.7; but it turns out we really should not try to push BeanProperty through at this point
findDeserializer in class AnnotationIntrospectorpublic Class<? extends KeyDeserializer> findKeyDeserializer(Annotated a)
AnnotationIntrospectorMap property.
Type of definition is either instance (of type
JsonDeserializer) or Class (of type
Class); if value of different
type is returned, a runtime exception may be thrown by caller.findKeyDeserializer in class AnnotationIntrospectorpublic Class<? extends JsonDeserializer<?>> findContentDeserializer(Annotated a)
AnnotationIntrospectorCollection, array or
Map property.
Type of definition is either instance (of type
JsonDeserializer) or Class (of type
Class); if value of different
type is returned, a runtime exception may be thrown by caller.findContentDeserializer in class AnnotationIntrospectorpublic Class<?> findDeserializationType(Annotated am, JavaType baseType, String propName)
AnnotationIntrospectorfindDeserializationType in class AnnotationIntrospectorbaseType - Assumed type before considering annotationspropName - Logical property name of the property that uses
type, if known; null for types not associated with propertypublic Class<?> findDeserializationKeyType(Annotated am, JavaType baseKeyType, String propName)
AnnotationIntrospectorMap types.findDeserializationKeyType in class AnnotationIntrospectorbaseKeyType - Assumed key type before considering annotationspropName - Logical property name of the property that uses
type, if known; null for types not associated with propertypublic Class<?> findDeserializationContentType(Annotated am, JavaType baseContentType, String propName)
AnnotationIntrospectorfindDeserializationContentType in class AnnotationIntrospectorbaseContentType - Assumed content (value) type before considering annotationspropName - Logical property name of the property that uses
type, if known; null for types not associated with propertypublic Object findValueInstantiator(AnnotatedClass ac)
AnnotationIntrospectorValueInstantiator to use for given
type (class): return value can either be an instance of
instantiator, or class of instantiator to create.findValueInstantiator in class AnnotationIntrospectorpublic String findSettablePropertyName(AnnotatedMethod am)
AnnotationIntrospectorfindSettablePropertyName in class AnnotationIntrospectorpublic boolean hasAnySetterAnnotation(AnnotatedMethod am)
AnnotationIntrospectorhasAnySetterAnnotation in class AnnotationIntrospectorpublic boolean hasAnyGetterAnnotation(AnnotatedMethod am)
AnnotationIntrospectorhasAnyGetterAnnotation in class AnnotationIntrospectorpublic boolean hasCreatorAnnotation(Annotated a)
AnnotationIntrospectorhasCreatorAnnotation in class AnnotationIntrospectorpublic String findDeserializablePropertyName(AnnotatedField af)
AnnotationIntrospectorfindDeserializablePropertyName in class AnnotationIntrospectorpublic String findPropertyNameForParam(AnnotatedParameter param)
AnnotationIntrospectorfindPropertyNameForParam in class AnnotationIntrospectorprotected boolean _isIgnorable(Annotated a)
protected TypeResolverBuilder<?> _findTypeResolver(MapperConfig<?> config, Annotated ann, JavaType baseType)
TypeResolverBuilder
if given annotated element indicates one is needed.protected StdTypeResolverBuilder _constructStdTypeResolverBuilder()
TypeResolverBuilder
implementation.protected StdTypeResolverBuilder _constructNoTypeResolverBuilder()