com.fasterxml.jackson.dataformat.xml

Interface XmlAnnotationIntrospector

All Known Implementing Classes:

JacksonXmlAnnotationIntrospector, XmlAnnotationIntrospector.JaxbWrapper, XmlAnnotationIntrospector.Pair, XmlJaxbAnnotationIntrospector

public interface XmlAnnotationIntrospector

Additional extension interface used above and beyond AnnotationIntrospector to handle XML-specific configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	XmlAnnotationIntrospector.JaxbWrapper Wrapper we need to adapt JaxbAnnotationIntrospector as XmlAnnotationIntrospector: something we can not (alas!) do in JAXB module because of dependency direction (JAXB module has no knowledge of this module).
static class	XmlAnnotationIntrospector.Pair Extension of AnnotationIntrospector.Pair that can also dispatch 'XmlAnnotationIntrospector' methods.

Method Summary

Methods

Modifier and Type	Method and Description
String	findNamespace(com.fasterxml.jackson.databind.introspect.Annotated ann) Method that can be called to figure out generic namespace property for an annotated object.
Boolean	isOutputAsAttribute(com.fasterxml.jackson.databind.introspect.Annotated ann) Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it be output as an XML attribute or not (as element)
Boolean	isOutputAsCData(com.fasterxml.jackson.databind.introspect.Annotated ann) Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it should be wrapped in a CDATA tag.
Boolean	isOutputAsText(com.fasterxml.jackson.databind.introspect.Annotated ann) Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it should be serialized as text, without element wrapper.

Method Detail

findNamespace

String findNamespace(com.fasterxml.jackson.databind.introspect.Annotated ann)

Method that can be called to figure out generic namespace property for an annotated object.

Returns:

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

isOutputAsAttribute

Boolean isOutputAsAttribute(com.fasterxml.jackson.databind.introspect.Annotated ann)

Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it be output as an XML attribute or not (as element)

isOutputAsText

Boolean isOutputAsText(com.fasterxml.jackson.databind.introspect.Annotated ann)

Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it should be serialized as text, without element wrapper.

isOutputAsCData

Boolean isOutputAsCData(com.fasterxml.jackson.databind.introspect.Annotated ann)

Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it should be wrapped in a CDATA tag.