|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.jackson.map.AnnotationIntrospector
public abstract class AnnotationIntrospector
Abstract class that defines API used for introspecting annotation-based configuration for serialization and deserialization. Separated so that different sets of annotations can be supported, and support plugged-in dynamically.
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.
Nested Class Summary | |
---|---|
static class |
AnnotationIntrospector.Pair
Helper class that allows using 2 introspectors such that one introspector acts as the primary one to use; and second one as a fallback used if the primary does not provide conclusive or useful result for a method. |
static class |
AnnotationIntrospector.ReferenceProperty
Value type used with managed and back references; contains type and logic name, used to link related references |
Constructor Summary | |
---|---|
AnnotationIntrospector()
|
Method Summary | |
---|---|
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. |
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. |
abstract Class<? extends JsonDeserializer<?>> |
findContentDeserializer(Annotated am)
Method for getting a deserializer definition for content (values) of associated Collection , array or
Map property. |
Class<? extends JsonSerializer<?>> |
findContentSerializer(Annotated am)
Method for getting a serializer definition for content (values) of associated Collection , array or Map property. |
abstract 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. |
abstract 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. |
abstract 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. |
abstract 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. |
abstract Object |
findDeserializer(Annotated am)
Method for getting a deserializer definition on specified method or field. |
abstract 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. |
abstract 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". |
abstract 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. |
abstract Class<? extends KeyDeserializer> |
findKeyDeserializer(Annotated am)
Method for getting a deserializer definition for keys of associated Map property. |
Class<? extends JsonSerializer<?>> |
findKeySerializer(Annotated am)
Method for getting a serializer definition for keys of associated Map property. |
abstract 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)
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. |
abstract 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)
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)
Note: defined as non-abstract to reduce fragility between versions. |
abstract 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. |
abstract 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. |
abstract String[] |
findSerializationPropertyOrder(AnnotatedClass ac)
Method for accessing defined property serialization order (which may be partial). |
abstract 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 |
abstract Class<?> |
findSerializationType(Annotated a)
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. |
abstract JsonSerialize.Typing |
findSerializationTyping(Annotated a)
Method for accessing declared typing mode annotated (if any). |
abstract 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. |
abstract Object |
findSerializer(Annotated am)
Method for getting a serializer definition on specified method or field. |
abstract 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. |
abstract 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. |
abstract boolean |
isHandled(Annotation ann)
Method called by framework to determine whether given annotation is handled by this introspector. |
abstract boolean |
isIgnorableConstructor(AnnotatedConstructor c)
|
abstract 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). |
abstract 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. |
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)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AnnotationIntrospector()
Method Detail |
---|
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 boolean isHandled(Annotation ann)
public Boolean findCachability(AnnotatedClass ac)
Currently only used with deserializers, to determine whether provider should cache instances, and if no annotations are found, assumes non-cachable instances.
public abstract String findRootName(AnnotatedClass ac)
public abstract String[] findPropertiesToIgnore(AnnotatedClass ac)
public abstract Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
public Boolean isIgnorableType(AnnotatedClass ac)
ac
- Type to check
public Object findFilterId(AnnotatedClass ac)
public VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac, VisibilityChecker<?> checker)
public TypeResolverBuilder<?> findTypeResolver(MapperConfig<?> config, AnnotatedClass ac, JavaType baseType)
findSubtypes(org.codehaus.jackson.map.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 found
public TypeResolverBuilder<?> findPropertyTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType baseType)
findSubtypes(org.codehaus.jackson.map.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 found
public TypeResolverBuilder<?> findPropertyContentTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType containerType)
findSubtypes(org.codehaus.jackson.map.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 AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
public Boolean shouldUnwrapProperty(AnnotatedMember member)
public boolean hasIgnoreMarker(AnnotatedMember m)
Default implementation calls existing 'isIgnored' methods
such as isIgnorableField(AnnotatedField)
and
isIgnorableMethod(AnnotatedMethod)
.
public Object findInjectableValueId(AnnotatedMember m)
InjectableValues
); often a simple String
id is used.
m
- Member to check
public abstract boolean isIgnorableMethod(AnnotatedMethod m)
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.
public abstract boolean isIgnorableConstructor(AnnotatedConstructor c)
public abstract boolean isIgnorableField(AnnotatedField f)
public abstract Object findSerializer(Annotated am)
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
public Class<? extends JsonSerializer<?>> findKeySerializer(Annotated am)
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.
public Class<? extends JsonSerializer<?>> findContentSerializer(Annotated am)
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.
public JsonSerialize.Inclusion findSerializationInclusion(Annotated a, JsonSerialize.Inclusion defValue)
public abstract Class<?> findSerializationType(Annotated a)
public Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
Map
types.
public Class<?> findSerializationContentType(Annotated am, JavaType baseType)
public abstract JsonSerialize.Typing findSerializationTyping(Annotated a)
public abstract Class<?>[] findSerializationViews(Annotated a)
a
- Annotated serializable property (field or getter method)
Object.class
)public abstract String[] findSerializationPropertyOrder(AnnotatedClass ac)
public abstract Boolean findSerializationSortAlphabetically(AnnotatedClass ac)
public abstract String findGettablePropertyName(AnnotatedMethod am)
public abstract boolean hasAsValueAnnotation(AnnotatedMethod am)
public abstract String findEnumValue(Enum<?> value)
public abstract String findSerializablePropertyName(AnnotatedField af)
public abstract Object findDeserializer(Annotated am)
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
public abstract Class<? extends KeyDeserializer> findKeyDeserializer(Annotated am)
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.
public abstract Class<? extends JsonDeserializer<?>> findContentDeserializer(Annotated am)
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.
public abstract Class<?> findDeserializationType(Annotated am, JavaType baseType, String propName)
baseType
- Assumed type before considering annotationspropName
- Logical property name of the property that uses
type, if known; null for types not associated with property
public abstract Class<?> findDeserializationKeyType(Annotated am, JavaType baseKeyType, String propName)
Map
types.
baseKeyType
- Assumed key type before considering annotationspropName
- Logical property name of the property that uses
type, if known; null for types not associated with property
public abstract Class<?> findDeserializationContentType(Annotated am, JavaType baseContentType, String propName)
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 property
public 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 abstract String findSettablePropertyName(AnnotatedMethod am)
public boolean hasAnySetterAnnotation(AnnotatedMethod am)
public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
public boolean hasCreatorAnnotation(Annotated a)
public abstract String findDeserializablePropertyName(AnnotatedField af)
public abstract String findPropertyNameForParam(AnnotatedParameter param)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |