Top Description Inners Methods
com.fasterxml.jackson.dataformat.xml

public Interface XmlAnnotationIntrospector

extends XmlExtensions
Known Direct Implementers
com.fasterxml.jackson.dataformat.xml.XmlAnnotationIntrospector.Pair, com.fasterxml.jackson.dataformat.xml.jaxb.XmlJaxbAnnotationIntrospector, com.fasterxml.jackson.dataformat.xml.JacksonXmlAnnotationIntrospector
Imports
com.fasterxml.jackson.databind.AnnotationIntrospector, com.fasterxml.jackson.databind.cfg.MapperConfig, com.fasterxml.jackson.databind.introspect.Annotated, .AnnotationIntrospectorPair

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XmlAnnotationIntrospector.Pair

Extension of AnnotationIntrospector.Pair that can also dispatch 'XmlAnnotationIntrospector' methods.

Method Summary

Inherited from com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions:
findNamespaceisOutputAsAttributeisOutputAsCDataisOutputAsText
com.fasterxml.jackson.dataformat.xml back to summary

public Class XmlAnnotationIntrospector.Pair

extends AnnotationIntrospectorPair
implements XmlAnnotationIntrospector
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.dataformat.xml.XmlAnnotationIntrospector, com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions

Extension of AnnotationIntrospector.Pair that can also dispatch 'XmlAnnotationIntrospector' methods.

Field Summary

Modifier and TypeField and Description
protected final AnnotationIntrospector.XmlExtensions
protected final AnnotationIntrospector.XmlExtensions
private static final long
Inherited from com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair:
_primary_secondary

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
findNamespace(MapperConfig<?>
Configuration settings in effect
config
,
Annotated
Annotated entity to introspect
ann
)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.findNamespace.

Method that can be called to figure out generic namespace property for an annotated object.
public static XmlAnnotationIntrospector.Pair
public Boolean
isOutputAsAttribute(MapperConfig<?>
Configuration settings in effect
config
,
Annotated
Annotated entity to introspect
ann
)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsAttribute.

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 (if not, then as element)
public Boolean
isOutputAsCData(MapperConfig<?>
Configuration settings in effect
config
,
Annotated
Annotated entity to introspect
ann
)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsCData.

Method used to check whether given annotated element (field, method, constructor parameter) has indicator that suggests it should be wrapped in a CDATA tag.
public Boolean
isOutputAsText(MapperConfig<?>
Configuration settings in effect
config
,
Annotated
Annotated entity to introspect
ann
)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsText.

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.
Inherited from com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair:
_explicitClassOrOb_isExplicitClassOrOballIntrospectorsallIntrospectorscreatefindAndAddVirtualPropertiesfindAutoDetectVisibilityfindClassDescriptionfindContentDeserializerfindContentSerializerfindCreatorAnnotationfindCreatorBindingfindDefaultEnumValuefindDefaultEnumValuefindDeserializationContentConverterfindDeserializationConverterfindDeserializerfindEnumAliasesfindEnumAliasesfindEnumNamingStrategyfindEnumValuefindEnumValuesfindEnumValuesfindFilterIdfindFormatfindIgnoreUnknownPropertiesfindImplicitPropertyNamefindInjectableValuefindInjectableValueIdfindKeyDeserializerfindKeySerializerfindMergeInfofindNameForDeserializationfindNameForSerializationfindNamingStrategyfindNullSerializerfindObjectIdInfofindObjectReferenceInfofindPOJOBuilderfindPOJOBuilderConfigfindPolymorphicTypeInfofindPropertiesToIgnorefindPropertyAccessfindPropertyAliasesfindPropertyContentTypeResolverfindPropertyDefaultValuefindPropertyDescriptionfindPropertyIgnoralByNamefindPropertyIgnoralsfindPropertyInclusionfindPropertyInclusionByNamefindPropertyIndexfindPropertyTypeResolverfindReferenceTypefindRenameByFieldfindRootNamefindSerializationContentConverterfindSerializationConverterfindSerializationPropertyOrderfindSerializationSortAlphabeticallyfindSerializationTypingfindSerializerfindSetterInfofindSubtypesfindTypeNamefindTypeResolverfindUnwrappingNameTransformerfindValueInstantiatorfindViewsfindWrapperNamehasAnyGetterhasAnyGetterAnnotationhasAnySetterhasAnySetterAnnotationhasAsKeyhasAsValuehasAsValueAnnotationhasCreatorAnnotationhasIgnoreMarkerhasRequiredMarkerisAnnotationBundleisIgnorableTypeisTypeIdrefineDeserializationTyperefineSerializationTyperesolveSetterConflictversion

Field Detail

_xmlPrimaryback to summary
protected final AnnotationIntrospector.XmlExtensions _xmlPrimary
_xmlSecondaryback to summary
protected final AnnotationIntrospector.XmlExtensions _xmlSecondary
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair.serialVersionUID.

Constructor Detail

Pairback to summary
public Pair(AnnotationIntrospector p, AnnotationIntrospector s)

Method Detail

findNamespaceback to summary
public String findNamespace(MapperConfig<?> config, Annotated ann)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.findNamespace.

Doc from com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.findNamespace.

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

Parameters
config:MapperConfig<?>

Configuration settings in effect

ann:Annotated

Annotated entity to introspect

Returns:String

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

Annotations
@Override
instanceback to summary
public static XmlAnnotationIntrospector.Pair instance(AnnotationIntrospector a1, AnnotationIntrospector a2)
isOutputAsAttributeback to summary
public Boolean isOutputAsAttribute(MapperConfig<?> config, Annotated ann)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsAttribute.

Doc from com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsAttribute.

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 (if not, then as element)

Parameters
config:MapperConfig<?>

Configuration settings in effect

ann:Annotated

Annotated entity to introspect

Returns:Boolean

Null if no indicator found; True or False otherwise

Annotations
@Override
isOutputAsCDataback to summary
public Boolean isOutputAsCData(MapperConfig<?> config, Annotated ann)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsCData.

Doc from com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsCData.

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

Parameters
config:MapperConfig<?>

Configuration settings in effect

ann:Annotated

Annotated entity to introspect

Returns:Boolean

Null if no indicator found; True or False otherwise

Annotations
@Override
isOutputAsTextback to summary
public Boolean isOutputAsText(MapperConfig<?> config, Annotated ann)

Implements com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsText.

Doc from com.fasterxml.jackson.databind.AnnotationIntrospector.XmlExtensions.isOutputAsText.

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.

Parameters
config:MapperConfig<?>

Configuration settings in effect

ann:Annotated

Annotated entity to introspect

Returns:Boolean

Null if no indicator found; True or False otherwise

Annotations
@Override