|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.codehaus.jackson.map.AnnotationIntrospector
org.codehaus.jackson.xc.JaxbAnnotationIntrospector
public class JaxbAnnotationIntrospector
Annotation introspector that leverages JAXB annotations where applicable to JSON mapping.
The following JAXB annotations are not supported yet (but some may be supported in future)XmlAnyAttribute not yet used (as of 1.5) but may be in future (as an alias for @JsonAnySetter?)
XmlAnyElement not yet used, may be as per [JACKSON-253]
XmlAttachmentRef: JSON does not support external attachments
XmlElementDecl
XmlElementRefs because Jackson doesn't have any support for 'named' collection items -- however,
this may become partially supported as per [JACKSON-253].
XmlID because Jackson doesn't support referential integrity. NOTE: this too may be supported
in future if/when id references are handled
XmlIDREF same as XmlID
XmlInlineBinaryData since the underlying concepts
(like XOP) do not exist in JSON -- Jackson will always use inline base64 encoding as the method
XmlList because JSON does have (or necessarily need)
method of serializing list of values as space-separated Strings
XmlMimeType
XmlMixed since JSON has no concept of mixed content
XmlRegistry
XmlRootElement is recognized and used (as of 1.7) for defining root wrapper name (if used)
XmlSchema not used, unlikely to be used
XmlSchemaType not used, unlikely to be used
XmlSchemaTypes not used, unlikely to be used
XmlSeeAlso not needed for anything currently (could theoretically be useful
for locating subtypes for Polymorphic Type Handling)
XmlValue will have a property named 'value' on its JSON object.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.codehaus.jackson.map.AnnotationIntrospector |
|---|
AnnotationIntrospector.Pair, AnnotationIntrospector.ReferenceProperty |
| Field Summary | |
|---|---|
protected JsonDeserializer<?> |
_dataHandlerDeserializer
|
protected JsonSerializer<?> |
_dataHandlerSerializer
|
protected String |
_jaxbPackageName
|
protected static String |
MARKER_FOR_DEFAULT
|
| Constructor Summary | |
|---|---|
JaxbAnnotationIntrospector()
|
|
| Method Summary | |
|---|---|
protected Class<?> |
_doFindDeserializationType(Annotated a,
JavaType baseType,
String propName)
|
protected TypeResolverBuilder<?> |
_typeResolverFromXmlElements(AnnotatedMember am)
|
protected XmlAccessType |
findAccessType(Annotated ac)
Method for locating JAXB XmlAccessType annotation value
for given annotated entity, if it has one, or inherits one from
its ancestors (in JAXB sense, package etc). |
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<JsonDeserializer<?>> |
findContentDeserializer(Annotated am)
Method for getting a deserializer 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 a,
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 a,
JavaType baseType,
String propName)
JAXB does allow specifying (more) concrete class for deserialization by using \@XmlElement annotation. |
JsonDeserializer<?> |
findDeserializer(Annotated am)
Method for getting a deserializer definition on specified method or field. |
String |
findEnumValue(Enum<?> e)
!!! 12-Oct-2009, tatu: This is hideously slow implementation, called potentially for every single enum value being serialized. |
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 |
Class<KeyDeserializer> |
findKeyDeserializer(Annotated am)
Method for getting a deserializer 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)
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 |
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. |
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. |
JsonSerialize.Inclusion |
findSerializationInclusion(Annotated a,
JsonSerialize.Inclusion defValue)
Implementation of this method is slightly tricky, given that JAXB defaults differ from Jackson defaults. |
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). |
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. |
JsonSerializer<?> |
findSerializer(Annotated am)
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. |
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 am)
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)
An annotation is handled if it's in the same package as @XmlElement, including subpackages. |
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. |
Version |
version()
Method that will return version information stored in and read from jar that contains this class. |
| Methods inherited from class org.codehaus.jackson.map.AnnotationIntrospector |
|---|
allIntrospectors, allIntrospectors, findContentSerializer, findFilterId, findInjectableValueId, findKeySerializer, findReferenceType, findSerializationContentType, findSerializationKeyType, findValueInstantiator, hasAnyGetterAnnotation, nopInstance, pair, shouldUnwrapProperty |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected static final String MARKER_FOR_DEFAULT
protected final String _jaxbPackageName
protected final JsonSerializer<?> _dataHandlerSerializer
protected final JsonDeserializer<?> _dataHandlerDeserializer
| Constructor Detail |
|---|
public JaxbAnnotationIntrospector()
| Method Detail |
|---|
public Version version()
version in interface Versionedpublic boolean isHandled(Annotation ann)
isHandled in class AnnotationIntrospectorann - The annotation.
public 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)
AnnotationIntrospector
findRootName in class AnnotationIntrospectorpublic String[] findPropertiesToIgnore(AnnotatedClass ac)
AnnotationIntrospector
findPropertiesToIgnore in class AnnotationIntrospectorpublic Boolean findIgnoreUnknownProperties(AnnotatedClass ac)
AnnotationIntrospector
findIgnoreUnknownProperties in class AnnotationIntrospectorpublic Boolean isIgnorableType(AnnotatedClass ac)
AnnotationIntrospector
isIgnorableType in class AnnotationIntrospectorac - Type to check
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 VisibilityChecker<?> findAutoDetectVisibility(AnnotatedClass ac,
VisibilityChecker<?> checker)
AnnotationIntrospector
findAutoDetectVisibility in class AnnotationIntrospectorprotected XmlAccessType findAccessType(Annotated ac)
XmlAccessType annotation value
for given annotated entity, if it has one, or inherits one from
its ancestors (in JAXB sense, package etc). Returns null if
nothing has been explicitly defined.
public 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 found
public TypeResolverBuilder<?> findPropertyTypeResolver(MapperConfig<?> config,
AnnotatedMember am,
JavaType baseType)
AnnotationIntrospectorAnnotationIntrospector.findSubtypes(org.codehaus.jackson.map.introspect.Annotated)
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 found
public TypeResolverBuilder<?> findPropertyContentTypeResolver(MapperConfig<?> config,
AnnotatedMember am,
JavaType containerType)
AnnotationIntrospectorAnnotationIntrospector.findSubtypes(org.codehaus.jackson.map.introspect.Annotated)
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)
protected TypeResolverBuilder<?> _typeResolverFromXmlElements(AnnotatedMember am)
public List<NamedType> findSubtypes(Annotated a)
AnnotationIntrospector
findSubtypes in class AnnotationIntrospectora - Annotated entity (class, field/method) to check for annotationspublic String findTypeName(AnnotatedClass ac)
AnnotationIntrospector
findTypeName 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)
AnnotationIntrospector
isIgnorableField in class AnnotationIntrospectorpublic JsonSerializer<?> findSerializer(Annotated am)
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<?> findSerializationType(Annotated a)
AnnotationIntrospector
findSerializationType in class AnnotationIntrospector
public JsonSerialize.Inclusion findSerializationInclusion(Annotated a,
JsonSerialize.Inclusion defValue)
findSerializationInclusion in class AnnotationIntrospectorpublic JsonSerialize.Typing findSerializationTyping(Annotated a)
AnnotationIntrospector
findSerializationTyping in class AnnotationIntrospectorpublic Class<?>[] findSerializationViews(Annotated a)
AnnotationIntrospector
findSerializationViews in class AnnotationIntrospectora - Annotated serializable property (field or getter method)
Object.class)public String[] findSerializationPropertyOrder(AnnotatedClass ac)
AnnotationIntrospector
findSerializationPropertyOrder in class AnnotationIntrospectorpublic Boolean findSerializationSortAlphabetically(AnnotatedClass ac)
AnnotationIntrospector
findSerializationSortAlphabetically in class AnnotationIntrospectorpublic String findGettablePropertyName(AnnotatedMethod am)
AnnotationIntrospector
findGettablePropertyName in class AnnotationIntrospectorpublic boolean hasAsValueAnnotation(AnnotatedMethod am)
AnnotationIntrospector
hasAsValueAnnotation in class AnnotationIntrospectorpublic String findEnumValue(Enum<?> e)
!!! 12-Oct-2009, tatu: This is hideously slow implementation, called potentially for every single enum value being serialized. Should improve...
findEnumValue in class AnnotationIntrospectorpublic String findSerializablePropertyName(AnnotatedField af)
AnnotationIntrospector
findSerializablePropertyName in class AnnotationIntrospectorpublic JsonDeserializer<?> findDeserializer(Annotated am)
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<KeyDeserializer> findKeyDeserializer(Annotated am)
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<JsonDeserializer<?>> findContentDeserializer(Annotated am)
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 AnnotationIntrospector
public Class<?> findDeserializationType(Annotated a,
JavaType baseType,
String propName)
findDeserializationType 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 property
public 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 property
public Class<?> findDeserializationContentType(Annotated a,
JavaType baseContentType,
String propName)
AnnotationIntrospector
findDeserializationContentType 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 property
protected Class<?> _doFindDeserializationType(Annotated a,
JavaType baseType,
String propName)
public String findSettablePropertyName(AnnotatedMethod am)
AnnotationIntrospector
findSettablePropertyName in class AnnotationIntrospectorpublic boolean hasAnySetterAnnotation(AnnotatedMethod am)
AnnotationIntrospector
hasAnySetterAnnotation in class AnnotationIntrospectorpublic boolean hasCreatorAnnotation(Annotated am)
AnnotationIntrospector
hasCreatorAnnotation in class AnnotationIntrospectorpublic String findDeserializablePropertyName(AnnotatedField af)
AnnotationIntrospector
findDeserializablePropertyName in class AnnotationIntrospectorpublic String findPropertyNameForParam(AnnotatedParameter param)
AnnotationIntrospector
findPropertyNameForParam in class AnnotationIntrospector
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||