org.codehaus.jackson.xc
Class JaxbAnnotationIntrospector

java.lang.Object
  org.codehaus.jackson.map.AnnotationIntrospector
      org.codehaus.jackson.xc.JaxbAnnotationIntrospector

public class JaxbAnnotationIntrospector
extends AnnotationIntrospector

Annotation introspector that leverages JAXB annotations where applicable to JSON mapping.

The following JAXB annotations were determined to be not-applicable:

• XmlAnyAttribute because it applies only to Map, which jackson can't serialize
• XmlAnyElement because it applies only to JAXBElement, which jackson can't serialize
• XmlAttachmentRef
• XmlElementDecl
• XmlElementRefs because Jackson doesn't have any support for 'named' collection items.
• XmlElements because Jackson doesn't have any support for 'named' collection items.
• XmlID because jackson' doesn't support referential integrity.
• XmlIDREF because jackson' doesn't support referential integrity.
• XmlInlineBinaryData
• XmlList because jackson doesn't support serializing collections to a single string.
• XmlMimeType
• XmlMixed
• XmlNs
• XmlRegistry
• XmlRootElement because there isn't an equivalent element name for a JSON object.
• XmlSchema
• XmlSchemaType
• XmlSchemaTypes
• XmlSeeAlso

Note also the following limitations:

• Any property annotated with XmlValue will have a property named 'value' on its JSON object.

Author:

Ryan Heaton

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.jackson.map.AnnotationIntrospector

AnnotationIntrospector.Pair

Constructor Summary

JaxbAnnotationIntrospector()

Method Summary

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).
protected XmlAdapter<Object,Object>	findAdapter(Annotated am) Finds the XmlAdapter for the specified annotation.
protected <A extends Annotation> A	findAnnotation(Class<A> annotationClass, Annotated annotated, boolean includePackage, boolean includeClass, boolean includeSuperclasses) Finds an annotation.
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.
Boolean	findCreatorAutoDetection(AnnotatedClass ac) Method for checking whether there is a class annotation that indicates whether creator-method auto detection should be enabled.
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) 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) Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use.
Class<?>	findDeserializationType(Annotated am) Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type.
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.
Boolean	findFieldAutoDetection(AnnotatedClass ac) Method for checking whether there is a class annotation that indicates whether field auto detection should be enabled.
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	findGetterAutoDetection(AnnotatedClass ac) Method for checking whether there is a class annotation that indicates whether (regular) getter-method auto detection should be enabled.
Boolean	findIsGetterAutoDetection(AnnotatedClass ac) Method for checking whether there is a class annotation that indicates whether (regular) getter-method auto detection should be enabled.
protected String	findJaxbPropertyName(AnnotatedElement ae, Class<?> aeType, String defaultName) Find the JAXB property name for the given annotated element.
protected String	findJaxbSpecifiedPropertyName(AnnotatedMethod am) Find the property name for the specified annotated method.
Class<KeyDeserializer>	findKeyDeserializer(Annotated am) Method for getting a deserializer definition for keys of associated Map property.
String	findNamespace(Annotated ann) Method that can be called to figure out generic namespace property for an annotated object.
protected PropertyDescriptor	findPropertyDescriptor(AnnotatedMethod m) Finds the property descriptor (adapted to AnnotatedElement) for the specified method.
String	findPropertyNameForParam(AnnotatedParameter param) Method for checking whether given set of annotations indicates property name for associated parameter.
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) By default only non-null properties are written (per the JAXB spec.)
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).
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".
Boolean	findSetterAutoDetection(AnnotatedClass ac) Method for checking whether there is a class annotation that indicates whether setter-method auto detection should be enabled.
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.
protected boolean	isFieldsAccessible(Annotated ac) Whether fields are accessible to this class.
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).
protected boolean	isInvisible(AnnotatedField f) Whether the specified field is invisible, per the JAXB visibility rules.
protected boolean	isInvisible(AnnotatedMethod m) Whether the specified method (assumed to be a property) is invisible, per the JAXB rules.
protected boolean	isPropertiesAccessible(Annotated ac) Whether properties are accessible to this class.

Methods inherited from class org.codehaus.jackson.map.AnnotationIntrospector

nopInstance, pair

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JaxbAnnotationIntrospector

public JaxbAnnotationIntrospector()

Method Detail

isHandled

public boolean isHandled(Annotation ann)

An annotation is handled if it's in the same package as @XmlElement, including subpackages.

Specified by:

isHandled in class AnnotationIntrospector

Parameters:

ann - The annotation.

Returns:

Whether the annotation is in the JAXB package.

findNamespace

public String findNamespace(Annotated ann)

Description copied from class: AnnotationIntrospector

Method that can be called to figure out generic namespace property for an annotated object. Most commonly used for XML compatibility purposes (since currently only JAXB annotations provide namespace information), but theoretically is not limited to XML.

Specified by:

findNamespace in class AnnotationIntrospector

Returns:

Null if annotated thing does not define any namespace information; non-null namespace (which may be empty String) otherwise

findCachability

public Boolean findCachability(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method that checks whether specified class has annotations that indicate that it is (or is not) cachable. Exact semantics depend on type of class annotated and using class (factory or provider).

Currently only used with deserializers, to determine whether provider should cache instances, and if no annotations are found, assumes non-cachable instances.

Specified by:

findCachability in class AnnotationIntrospector

Returns:

True, if class is considered cachable within context, False if not, and null if introspector does not care either way.

findFieldAutoDetection

public Boolean findFieldAutoDetection(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for checking whether there is a class annotation that indicates whether field auto detection should be enabled.

Specified by:

findFieldAutoDetection in class AnnotationIntrospector

Returns:

null if no relevant annotation is located; Boolean.TRUE if enabling annotation found, Boolean.FALSE if disabling annotation

findRootName

public String findRootName(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

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. Returns null if no declaration found; can return explicit empty String, which is usually ignored as well as null.

Specified by:

findRootName in class AnnotationIntrospector

isIgnorableMethod

public boolean isIgnorableMethod(AnnotatedMethod m)

Description copied from class: AnnotationIntrospector

Method for checking whether there is an annotation that indicates that given method should be ignored for all operations (serialization, deserialization).

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.

Specified by:

isIgnorableMethod in class AnnotationIntrospector

Returns:

True, if an annotation is found to indicate that the method should be ignored; false if not.

isIgnorableConstructor

public boolean isIgnorableConstructor(AnnotatedConstructor c)

Specified by:

isIgnorableConstructor in class AnnotationIntrospector

isIgnorableField

public boolean isIgnorableField(AnnotatedField f)

Description copied from class: AnnotationIntrospector

Method for checking whether there is an annotation that indicates that given field should be ignored for all operations (serialization, deserialization).

Specified by:

isIgnorableField in class AnnotationIntrospector

Returns:

True, if an annotation is found to indicate that the field should be ignored; false if not.

findSerializer

public JsonSerializer<?> findSerializer(Annotated am)

Description copied from class: AnnotationIntrospector

Method for getting a serializer definition on specified method or field. 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.

Specified by:

findSerializer in class AnnotationIntrospector

findSerializationType

public Class<?> findSerializationType(Annotated a)

Description copied from class: AnnotationIntrospector

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. Type returned (if any) needs to be widening conversion (super-type). Declared return type of the method is also considered acceptable.

Specified by:

findSerializationType in class AnnotationIntrospector

Returns:

Class to use instead of runtime type

findSerializationInclusion

public JsonSerialize.Inclusion findSerializationInclusion(Annotated a,
                                                          JsonSerialize.Inclusion defValue)

By default only non-null properties are written (per the JAXB spec.)

Specified by:

findSerializationInclusion in class AnnotationIntrospector

Returns:

JsonSerialize.Inclusion.NON_NULL

findSerializationTyping

public JsonSerialize.Typing findSerializationTyping(Annotated a)

Description copied from class: AnnotationIntrospector

Method for accessing declared typing mode annotated (if any). This is used for type detection, unless more granular settings (such as actual exact type; or serializer to use which means no type information is needed) take precedence.

Specified by:

findSerializationTyping in class AnnotationIntrospector

Returns:

Typing mode to use, if annotation is found; null otherwise

findGetterAutoDetection

public Boolean findGetterAutoDetection(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for checking whether there is a class annotation that indicates whether (regular) getter-method auto detection should be enabled. Getter methods are methods with name "getXxx()" (for property "xxx"); "isXxx()" are not included (instead those are considered "is getters")

Specified by:

findGetterAutoDetection in class AnnotationIntrospector

Returns:

null if no relevant annotation is located; Boolean.TRUE if enabling annotation found, Boolean.FALSE if disabling annotation

findIsGetterAutoDetection

public Boolean findIsGetterAutoDetection(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for checking whether there is a class annotation that indicates whether (regular) getter-method auto detection should be enabled. Getter methods are methods with name "getXxx()" (for property "xxx"); "isXxx()" are not included (instead those are considered "is getters")

Specified by:

findIsGetterAutoDetection in class AnnotationIntrospector

Returns:

null if no relevant annotation is located; Boolean.TRUE if enabling annotation found, Boolean.FALSE if disabling annotation

Since:

1.3

findGettablePropertyName

public String findGettablePropertyName(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

Method for checking whether given method has an annotation that suggests property name associated with method that may be a "getter". Should return null if no annotation is found; otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use standard bean name detection if applicable; method name if not".

Specified by:

findGettablePropertyName in class AnnotationIntrospector

hasAsValueAnnotation

public boolean hasAsValueAnnotation(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

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.

Specified by:

hasAsValueAnnotation in class AnnotationIntrospector

Returns:

True if such annotation is found (and is not disabled); false if no enabled annotation is found

findEnumValue

public String findEnumValue(Enum<?> e)

!!! 12-Oct-2009, tatu: This is hideously slow implementation, called potentially for every single enum value being serialized. Need to improve somehow

Specified by:

findEnumValue in class AnnotationIntrospector

Returns:

Serialized enum value.

isInvisible

protected boolean isInvisible(AnnotatedField f)

Whether the specified field is invisible, per the JAXB visibility rules.

Parameters:

f - The field.

Returns:

Whether the field is invisible.

isInvisible

protected boolean isInvisible(AnnotatedMethod m)

Whether the specified method (assumed to be a property) is invisible, per the JAXB rules.

Parameters:

m - The method.

Returns:

whether the method is invisible.

findSerializablePropertyName

public String findSerializablePropertyName(AnnotatedField af)

Description copied from class: AnnotationIntrospector

Method for checking whether given member field represent a serializable logical property; and if so, returns the name of that property. Should return null if no annotation is found (indicating it is not a serializable field); otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use the field name as is".

Specified by:

findSerializablePropertyName in class AnnotationIntrospector

findDeserializer

public JsonDeserializer<?> findDeserializer(Annotated am)

Description copied from class: AnnotationIntrospector

Method for getting a deserializer definition on specified method or field. 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.

Specified by:

findDeserializer in class AnnotationIntrospector

findKeyDeserializer

public Class<KeyDeserializer> findKeyDeserializer(Annotated am)

Description copied from class: AnnotationIntrospector

Method for getting a deserializer definition for keys of associated 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.

Specified by:

findKeyDeserializer in class AnnotationIntrospector

findContentDeserializer

public Class<JsonDeserializer<?>> findContentDeserializer(Annotated am)

Description copied from class: AnnotationIntrospector

Method for getting a deserializer definition for content (values) of associated 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.

Specified by:

findContentDeserializer in class AnnotationIntrospector

findDeserializationType

public Class<?> findDeserializationType(Annotated am)

Description copied from class: AnnotationIntrospector

Method for accessing annotated type definition that a method can have, to be used as the type for serialization instead of the runtime type. Type must be a narrowing conversion (i.e.subtype of declared type). Declared return type of the method is also considered acceptable.

Specified by:

findDeserializationType in class AnnotationIntrospector

Returns:

Class to use for deserialization instead of declared type

findDeserializationKeyType

public Class<?> findDeserializationKeyType(Annotated am)

Description copied from class: AnnotationIntrospector

Method for accessing additional narrowing type definition that a method can have, to define more specific key type to use. It should be only be used with Map types.

Specified by:

findDeserializationKeyType in class AnnotationIntrospector

Returns:

Class specifying more specific type to use instead of declared type, if annotation found; null if not

findDeserializationContentType

public Class<?> findDeserializationContentType(Annotated am)

Description copied from class: AnnotationIntrospector

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. It should be only be used with Map, Collection and array types.

Specified by:

findDeserializationContentType in class AnnotationIntrospector

Returns:

Class specifying more specific type to use instead of declared type, if annotation found; null if not

findSetterAutoDetection

public Boolean findSetterAutoDetection(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for checking whether there is a class annotation that indicates whether setter-method auto detection should be enabled.

Specified by:

findSetterAutoDetection in class AnnotationIntrospector

Returns:

null if no relevant annotation is located; Boolean.TRUE if enabling annotation found, Boolean.FALSE if disabling annotation

findCreatorAutoDetection

public Boolean findCreatorAutoDetection(AnnotatedClass ac)

Description copied from class: AnnotationIntrospector

Method for checking whether there is a class annotation that indicates whether creator-method auto detection should be enabled.

Specified by:

findCreatorAutoDetection in class AnnotationIntrospector

Returns:

null if no relevant annotation is located; Boolean.TRUE if enabling annotation found, Boolean.FALSE if disabling annotation

findSettablePropertyName

public String findSettablePropertyName(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

Method for checking whether given method has an annotation that suggests property name associated with method that may be a "setter". Should return null if no annotation is found; otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use standard bean name detection if applicable; method name if not".

Specified by:

findSettablePropertyName in class AnnotationIntrospector

hasAnySetterAnnotation

public boolean hasAnySetterAnnotation(AnnotatedMethod am)

Description copied from class: AnnotationIntrospector

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.

Specified by:

hasAnySetterAnnotation in class AnnotationIntrospector

Returns:

True if such annotation is found (and is not disabled), false otherwise

hasCreatorAnnotation

public boolean hasCreatorAnnotation(Annotated am)

Description copied from class: AnnotationIntrospector

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.

Specified by:

hasCreatorAnnotation in class AnnotationIntrospector

Returns:

True if such annotation is found (and is not disabled), false otherwise

findDeserializablePropertyName

public String findDeserializablePropertyName(AnnotatedField af)

Description copied from class: AnnotationIntrospector

Method for checking whether given member field represent a deserializable logical property; and if so, returns the name of that property. Should return null if no annotation is found (indicating it is not a deserializable field); otherwise a non-null String. If non-null value is returned, it is used as the property name, except for empty String ("") which is taken to mean "use the field name as is".

Specified by:

findDeserializablePropertyName in class AnnotationIntrospector

findPropertyNameForParam

public String findPropertyNameForParam(AnnotatedParameter param)

Description copied from class: AnnotationIntrospector

Method for checking whether given set of annotations indicates property name for associated parameter. No actual parameter object can be passed since JDK offers no representation; just annotations.

Specified by:

findPropertyNameForParam in class AnnotationIntrospector

findAnnotation

protected <A extends Annotation> A findAnnotation(Class<A> annotationClass,
                                                  Annotated annotated,
                                                  boolean includePackage,
                                                  boolean includeClass,
                                                  boolean includeSuperclasses)

Finds an annotation.

Parameters:

annotationClass - the annotation class.

annotated - The annotated element.

includePackage - Whether the annotation can be found on the package of the annotated element.

includeClass - Whether the annotation can be found on the class of the annotated element.

includeSuperclasses - Whether the annotation can be found on any superclasses of the class of the annotated element.

Returns:

The annotation, or null if not found.

isPropertiesAccessible

protected boolean isPropertiesAccessible(Annotated ac)

Whether properties are accessible to this class.

Parameters:

ac - The annotated class.

Returns:

Whether properties are accessible to this class.

findAccessType

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). Returns null if nothing has been explicitly defined.

isFieldsAccessible

protected boolean isFieldsAccessible(Annotated ac)

Whether fields are accessible to this class.

Parameters:

ac - The annotated class.

Returns:

Whether fields are accessible to this class.

findPropertyDescriptor

protected PropertyDescriptor findPropertyDescriptor(AnnotatedMethod m)

Finds the property descriptor (adapted to AnnotatedElement) for the specified method.

Parameters:

m - The method.

Returns:

The property descriptor, or null if not found.

findJaxbSpecifiedPropertyName

protected String findJaxbSpecifiedPropertyName(AnnotatedMethod am)

Find the property name for the specified annotated method. Takes into account any JAXB annotation that can be mapped to a JSON property.

Parameters:

am - The annotated method.

Returns:

The property name, or null if no JAXB annotation specifies the property name.

findJaxbPropertyName

protected String findJaxbPropertyName(AnnotatedElement ae,
                                      Class<?> aeType,
                                      String defaultName)

Find the JAXB property name for the given annotated element.

Parameters:

ae - The annotated element.

aeType - The type of the annotated element.

defaultName - The default name if nothing is specified.

Returns:

The JAXB property name, if found (null if no annotations found); defaultName if annotation has value indicating default should be used.

findAdapter

protected XmlAdapter<Object,Object> findAdapter(Annotated am)

Finds the XmlAdapter for the specified annotation.

Parameters:

am - The annotated element.

Returns:

The adapter, or null if none.