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, pair
public boolean isHandled(Annotation ann)
AnnotationIntrospector
isHandled
in class AnnotationIntrospector
public String findEnumValue(Enum<?> value)
AnnotationIntrospector
NOTE: implemented since 1.9.11, to make things work even when annotation introspection is disabled.
findEnumValue
in class AnnotationIntrospector
public Boolean findCachability(AnnotatedClass ac)
AnnotationIntrospector
Currently only used with deserializers, to determine whether provider should cache instances, and if no annotations are found, assumes non-cachable instances.
findCachability
in class AnnotationIntrospector
public String findRootName(AnnotatedClass ac)
AnnotationIntrospector
findRootName
in class AnnotationIntrospector
public String[] findPropertiesToIgnore(AnnotatedClass ac)
AnnotationIntrospector
findPropertiesToIgnore
in class AnnotationIntrospector
public Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
AnnotationIntrospector
findIgnoreUnknownProperties
in class AnnotationIntrospector
public Boolean isIgnorableType(AnnotatedClass ac)
AnnotationIntrospector
isIgnorableType
in class AnnotationIntrospector
ac
- Type to checkpublic Object findFilterId(AnnotatedClass ac)
AnnotationIntrospector
findFilterId
in class AnnotationIntrospector
public VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)
AnnotationIntrospector
findAutoDetectVisibility
in class AnnotationIntrospector
public AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
AnnotationIntrospector
findReferenceType
in class AnnotationIntrospector
public Boolean shouldUnwrapProperty(AnnotatedMember member)
AnnotationIntrospector
shouldUnwrapProperty
in class AnnotationIntrospector
public boolean hasIgnoreMarker(AnnotatedMember m)
AnnotationIntrospector
Default implementation calls existing 'isIgnored' methods
such as AnnotationIntrospector.isIgnorableField(AnnotatedField)
and
AnnotationIntrospector.isIgnorableMethod(AnnotatedMethod)
.
hasIgnoreMarker
in class AnnotationIntrospector
public Object findInjectableValueId(AnnotatedMember m)
AnnotationIntrospector
InjectableValues
); often a simple String
id is used.findInjectableValueId
in class AnnotationIntrospector
m
- Member to checkpublic TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)
AnnotationIntrospector
AnnotationIntrospector.findSubtypes(org.codehaus.jackson.map.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)
JsonTypeInfo
from a property too.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 containerType)
JsonTypeInfo
from a property too.findPropertyContentTypeResolver
in class AnnotationIntrospector
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)
AnnotationIntrospector
findSubtypes
in class AnnotationIntrospector
a
- Annotated entity (class, field/method) to check for annotationspublic String findTypeName(AnnotatedClass ac)
AnnotationIntrospector
findTypeName
in class AnnotationIntrospector
ac
- Class to check for type name annotationspublic boolean isIgnorableMethod(AnnotatedMethod m)
AnnotationIntrospector
Note 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 AnnotationIntrospector
public boolean isIgnorableConstructor(AnnotatedConstructor c)
isIgnorableConstructor
in class AnnotationIntrospector
public boolean isIgnorableField(AnnotatedField f)
AnnotationIntrospector
isIgnorableField
in class AnnotationIntrospector
public Object findSerializer(Annotated a)
AnnotationIntrospector
JsonSerializer
) 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 AnnotationIntrospector
public Class<? extends JsonSerializer<?>> findKeySerializer(Annotated a)
AnnotationIntrospector
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.findKeySerializer
in class AnnotationIntrospector
public Class<? extends JsonSerializer<?>> findContentSerializer(Annotated a)
AnnotationIntrospector
Collection
, array
or Map
property.
Type of definition is either instance (of type
JsonSerializer
) or Class (of type
Class
); if value of different
type is returned, a runtime exception may be thrown by caller.findContentSerializer
in class AnnotationIntrospector
public JsonSerialize.Inclusion findSerializationInclusion(Annotated a, JsonSerialize.Inclusion defValue)
AnnotationIntrospector
findSerializationInclusion
in class AnnotationIntrospector
public Class<?> findSerializationType(Annotated am)
AnnotationIntrospector
findSerializationType
in class AnnotationIntrospector
public Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
AnnotationIntrospector
Map
types.findSerializationKeyType
in class AnnotationIntrospector
public Class<?> findSerializationContentType(Annotated am, JavaType baseType)
AnnotationIntrospector
findSerializationContentType
in class AnnotationIntrospector
public JsonSerialize.Typing findSerializationTyping(Annotated a)
AnnotationIntrospector
findSerializationTyping
in class AnnotationIntrospector
public Class<?>[] findSerializationViews(Annotated a)
AnnotationIntrospector
findSerializationViews
in class AnnotationIntrospector
a
- Annotated serializable property (field or getter method)Object.class
)public String[] findSerializationPropertyOrder(AnnotatedClass ac)
AnnotationIntrospector
findSerializationPropertyOrder
in class AnnotationIntrospector
public Boolean findSerializationSortAlphabetically(AnnotatedClass ac)
AnnotationIntrospector
findSerializationSortAlphabetically
in class AnnotationIntrospector
public String findGettablePropertyName(AnnotatedMethod am)
AnnotationIntrospector
findGettablePropertyName
in class AnnotationIntrospector
public boolean hasAsValueAnnotation(AnnotatedMethod am)
AnnotationIntrospector
hasAsValueAnnotation
in class AnnotationIntrospector
public String findSerializablePropertyName(AnnotatedField af)
AnnotationIntrospector
findSerializablePropertyName
in class AnnotationIntrospector
public Class<? extends JsonDeserializer<?>> findDeserializer(Annotated a)
AnnotationIntrospector
JsonDeserializer
) 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 AnnotationIntrospector
public Class<? extends KeyDeserializer> findKeyDeserializer(Annotated a)
AnnotationIntrospector
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.findKeyDeserializer
in class AnnotationIntrospector
public Class<? extends JsonDeserializer<?>> findContentDeserializer(Annotated a)
AnnotationIntrospector
Collection
, array
or
Map
property.
Type of definition is either instance (of type
JsonDeserializer
) or Class (of type
Class
); if value of different
type is returned, a runtime exception may be thrown by caller.findContentDeserializer
in class AnnotationIntrospector
public Class<?> findDeserializationType(Annotated am, JavaType baseType, String propName)
AnnotationIntrospector
findDeserializationType
in class AnnotationIntrospector
baseType
- 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)
AnnotationIntrospector
Map
types.findDeserializationKeyType
in class AnnotationIntrospector
baseKeyType
- 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)
AnnotationIntrospector
findDeserializationContentType
in class AnnotationIntrospector
baseContentType
- 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)
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
public String findSettablePropertyName(AnnotatedMethod am)
AnnotationIntrospector
findSettablePropertyName
in class AnnotationIntrospector
public boolean hasAnySetterAnnotation(AnnotatedMethod am)
AnnotationIntrospector
hasAnySetterAnnotation
in class AnnotationIntrospector
public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
AnnotationIntrospector
hasAnyGetterAnnotation
in class AnnotationIntrospector
public boolean hasCreatorAnnotation(Annotated a)
AnnotationIntrospector
hasCreatorAnnotation
in class AnnotationIntrospector
public String findDeserializablePropertyName(AnnotatedField af)
AnnotationIntrospector
findDeserializablePropertyName
in class AnnotationIntrospector
public String findPropertyNameForParam(AnnotatedParameter param)
AnnotationIntrospector
findPropertyNameForParam
in class AnnotationIntrospector
protected 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()