|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.fasterxml.jackson.databind.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). |
Object |
findContentDeserializer(Annotated am)
Method for getting a deserializer definition for content (values) of associated Collection , array or
Map property. |
Object |
findContentSerializer(Annotated am)
Method for getting a serializer definition for content (values) of associated Collection , array or Map property. |
Class<?> |
findDeserializationContentType(Annotated am,
JavaType baseContentType)
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)
Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use. |
String |
findDeserializationName(AnnotatedField af)
Method for checking whether given member field represent a deserializable logical property; and if so, returns the name of that property. |
String |
findDeserializationName(AnnotatedMethod am)
Method for checking whether given method has an annotation that suggests property name associated with method that may be a "setter". |
String |
findDeserializationName(AnnotatedParameter param)
Method for checking whether given set of annotations indicates property name for associated parameter. |
Class<?> |
findDeserializationType(Annotated am,
JavaType baseType)
Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type. |
Object |
findDeserializer(Annotated am)
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. |
com.fasterxml.jackson.annotation.JsonFormat.Value |
findFormat(AnnotatedMember member)
Method for finding format annotations for given member. |
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. |
Object |
findKeyDeserializer(Annotated am)
Method for getting a deserializer definition for keys of associated Map property. |
Object |
findKeySerializer(Annotated am)
Method for getting a serializer definition for keys of associated Map property. |
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. |
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)
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. |
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). |
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. |
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. |
com.fasterxml.jackson.annotation.JsonInclude.Include |
findSerializationInclusion(Annotated a,
com.fasterxml.jackson.annotation.JsonInclude.Include 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 |
findSerializationName(AnnotatedField af)
Method for checking whether given member field represent a serializable logical property; and if so, returns the name of that property. |
String |
findSerializationName(AnnotatedMethod am)
Method for checking whether given method has an annotation that suggests property name associated with method that may be a "getter". |
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 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. |
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. |
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. |
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. |
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 |
isHandled(Annotation ann)
Method called by framework to determine whether given annotation is handled by this introspector. |
Boolean |
isIgnorableType(AnnotatedClass ac)
Method for checking whether properties that have specified type (class, not generics aware) should be completely ignored for serialization and deserialization purposes. |
Boolean |
isTypeId(AnnotatedMember member)
Method for checking whether given accessor claims to represent type id: if so, its value may be used as an override, instead of generated type id. |
static AnnotationIntrospector |
nopInstance()
Factory method for accessing "no operation" implementation of introspector: instance that will never find any annotation-based configuration. |
static AnnotationIntrospector |
pair(AnnotationIntrospector a1,
AnnotationIntrospector a2)
|
abstract com.fasterxml.jackson.core.Version |
version()
|
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 com.fasterxml.jackson.core.Version version()
version
in interface com.fasterxml.jackson.core.Versioned
public boolean isHandled(Annotation ann)
public boolean isAnnotationBundle(Annotation ann)
public ObjectIdInfo findObjectIdInfo(Annotated ann)
public String findRootName(AnnotatedClass ac)
public String[] findPropertiesToIgnore(Annotated ac)
public 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(com.fasterxml.jackson.databind.introspect.Annotated)
config
- Configuration settings in effect (for serialization or deserialization)ac
- Annotated class to check for annotationsbaseType
- Base java type of value for which resolver is to be found
public TypeResolverBuilder<?> findPropertyTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType baseType)
findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
config
- Configuration settings in effect (for serialization or deserialization)am
- Annotated member (field or method) to check for annotationsbaseType
- Base java type of property for which resolver is to be found
public TypeResolverBuilder<?> findPropertyContentTypeResolver(MapperConfig<?> config, AnnotatedMember am, JavaType containerType)
findSubtypes(com.fasterxml.jackson.databind.introspect.Annotated)
config
- Configuration settings in effect (for serialization or deserialization)am
- Annotated member (field or method) to check for annotationscontainerType
- Type of property for which resolver is to be found (must be a container type)
public List<NamedType> findSubtypes(Annotated a)
a
- Annotated entity (class, field/method) to check for annotationspublic String findTypeName(AnnotatedClass ac)
ac
- Class to check for type name annotationspublic AnnotationIntrospector.ReferenceProperty findReferenceType(AnnotatedMember member)
public NameTransformer findUnwrappingNameTransformer(AnnotatedMember member)
public boolean hasIgnoreMarker(AnnotatedMember m)
public Object findInjectableValueId(AnnotatedMember m)
InjectableValues
); often a simple String
id is used.
m
- Member to check
public Boolean hasRequiredMarker(AnnotatedMember m)
public Class<?>[] findViews(Annotated a)
a
- Annotated property (represented by a method, field or ctor parameter)
Object.class
)public com.fasterxml.jackson.annotation.JsonFormat.Value findFormat(AnnotatedMember member)
public Boolean isTypeId(AnnotatedMember member)
public 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.
public Object 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 Object 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 com.fasterxml.jackson.annotation.JsonInclude.Include findSerializationInclusion(Annotated a, com.fasterxml.jackson.annotation.JsonInclude.Include defValue)
public Class<?> findSerializationType(Annotated a)
public Class<?> findSerializationKeyType(Annotated am, JavaType baseType)
Map
types.
public Class<?> findSerializationContentType(Annotated am, JavaType baseType)
public JsonSerialize.Typing findSerializationTyping(Annotated a)
public String[] findSerializationPropertyOrder(AnnotatedClass ac)
public Boolean findSerializationSortAlphabetically(AnnotatedClass ac)
public String findSerializationName(AnnotatedMethod am)
public boolean hasAsValueAnnotation(AnnotatedMethod am)
public String findEnumValue(Enum<?> value)
public String findSerializationName(AnnotatedField af)
public 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.
public Object 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 Object 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 Class<?> findDeserializationType(Annotated am, JavaType baseType)
baseType
- Assumed type before considering annotations
public Class<?> findDeserializationKeyType(Annotated am, JavaType baseKeyType)
Map
types.
baseKeyType
- Assumed key type before considering annotations
public Class<?> findDeserializationContentType(Annotated am, JavaType baseContentType)
baseContentType
- Assumed content (value) type before considering annotations
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 Class<?> findPOJOBuilder(AnnotatedClass ac)
Note that unlike accessors for some helper Objects, this method does not allow returning instances: the reason is that builders have state, and a separate instance needs to be created for each deserialization call.
public JsonPOJOBuilder.Value findPOJOBuilderConfig(AnnotatedClass ac)
public String findDeserializationName(AnnotatedMethod am)
public boolean hasAnySetterAnnotation(AnnotatedMethod am)
public boolean hasAnyGetterAnnotation(AnnotatedMethod am)
public boolean hasCreatorAnnotation(Annotated a)
public String findDeserializationName(AnnotatedField af)
public String findDeserializationName(AnnotatedParameter param)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |