Jackson 2.18.2 · com.fasterxml.jackson.dataformat.xml.JacksonXmlModule

Module that implements most functionality needed to support producing and consuming XML instead of JSON, used by XmlMapper for registering handlers for XML-specific processing.

Note

please do NOT register this directly on XmlMapper: mapper registers an instance (either one explicitly given in constructor, or, if none, one it configures) and attempts to re-register is unlikely to work as you'd expect.

Field Summary

Modifier and Type	Field and Description
protected boolean	_cfgDefaultUseWrapper Determination of whether indexed properties (arrays, Lists) that are not explicitly annotated (with `com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper` or equivalent) should default to using implicit wrapper (with same name as property) or not.
protected String	_cfgNameForTextElement Name used for pseudo-property used for returning XML Text value (which does not have actual element name to use).
protected SerializerFactory	_serializerFactoryOverride Optional override for `SerializerFactory` used by `XmlMapper`.
private static final long	serialVersionUID Hides com.fasterxml.jackson.databind.module.SimpleModule.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.module.SimpleModule:: _abstractTypes _deserializerModifier _deserializers _hasExplicitName _keyDeserializers _keySerializers _mixins _name _namingStrategy _serializerModifier _serializers _subtypes _valueInstantiators _version

Constructor Summary

Access	Constructor and Description
public	JacksonXmlModule()

Method Summary

Modifier and Type	Method and Description
protected AnnotationIntrospector	_constructIntrospector()
public JacksonXmlModule	overrideSerializerFactory(SerializerFactory factory) Method to use for overriding default `SerializerFactory` used
public SerializerFactory	serializerFactoryOverride()
public void	setDefaultUseWrapper(boolean Whether to enable or disable "use wrapper for non-annotated List properties" state) Method that can be used to define whether `AnnotationIntrospector` we register will use wrapper for indexed (List, array) properties or not, if there are no explicit annotations.
public void	setupModule(Module.SetupContext context) Overrides com.fasterxml.jackson.databind.module.SimpleModule.setupModule. Standard implementation handles registration of all configured customizations: it is important that sub-classes call this implementation (usually before additional custom logic) if they choose to override it; otherwise customizations will not be registered.
public void	setXMLTextElementName(String Virtual name to use when exposing XML character data sections name) Method that can be used to define alternate "virtual name" to use for XML CDATA segments; that is, text values.

Field Detail

_cfgDefaultUseWrapper back to summary

_cfgDefaultUseWrapper	back to summary
protected boolean _cfgDefaultUseWrapper Determination of whether indexed properties (arrays, Lists) that are not explicitly annotated (with `com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper` or equivalent) should default to using implicit wrapper (with same name as property) or not. If enabled, wrapping is used by default; if false, it is not. Note that JAXB annotation introspector always assumes "do not wrap by default". Jackson annotations have different default due to backwards compatibility. Since 2.1

protected boolean _cfgDefaultUseWrapper

Determination of whether indexed properties (arrays, Lists) that are not explicitly annotated (with com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper or equivalent) should default to using implicit wrapper (with same name as property) or not. If enabled, wrapping is used by default; if false, it is not.

Note that JAXB annotation introspector always assumes "do not wrap by default". Jackson annotations have different default due to backwards compatibility.

Since: 2.1

_cfgNameForTextElement	back to summary
protected String _cfgNameForTextElement Name used for pseudo-property used for returning XML Text value (which does not have actual element name to use). Defaults to empty String, but may be changed for inter-operability reasons: JAXB, for example, uses "value" as name. Since 2.1

_cfgNameForTextElement

back to summary

protected String _cfgNameForTextElement

Name used for pseudo-property used for returning XML Text value (which does not have actual element name to use). Defaults to empty String, but may be changed for inter-operability reasons: JAXB, for example, uses "value" as name.

Since: 2.1

_serializerFactoryOverride back to summary

_serializerFactoryOverride	back to summary
protected SerializerFactory _serializerFactoryOverride Optional override for `SerializerFactory` used by `XmlMapper`. Needed to allow proper override and configurability using custom {@SerializerFactory } implementations. Since 2.18.2

protected SerializerFactory _serializerFactoryOverride

Optional override for SerializerFactory used by XmlMapper. Needed to allow proper override and configurability using custom {@SerializerFactory } implementations.

Since: 2.18.2

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.fasterxml.jackson.databind.module.SimpleModule.serialVersionUID.

Constructor Detail

JacksonXmlModule	back to summary
public JacksonXmlModule()

Method Detail

_constructIntrospector	back to summary
protected AnnotationIntrospector _constructIntrospector()

overrideSerializerFactory back to summary

overrideSerializerFactory	back to summary
public JacksonXmlModule overrideSerializerFactory(SerializerFactory factory) Method to use for overriding default `SerializerFactory` used Since 2.18.2

public JacksonXmlModule overrideSerializerFactory(SerializerFactory factory)

Method to use for overriding default SerializerFactory used

Since: 2.18.2

serializerFactoryOverride	back to summary
public SerializerFactory serializerFactoryOverride() Since 2.18.2

setDefaultUseWrapper back to summary

setDefaultUseWrapper	back to summary
public void setDefaultUseWrapper(boolean state) Method that can be used to define whether `AnnotationIntrospector` we register will use wrapper for indexed (List, array) properties or not, if there are no explicit annotations. See `com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper` for details. Note that method MUST be called before registering the module; otherwise change will not have any effect. Parameters state:boolean Whether to enable or disable "use wrapper for non-annotated List properties" Since 2.1

public void setDefaultUseWrapper(boolean state)

Method that can be used to define whether AnnotationIntrospector we register will use wrapper for indexed (List, array) properties or not, if there are no explicit annotations. See com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper for details.

Note that method MUST be called before registering the module; otherwise change will not have any effect.

Parameters

state:boolean: Whether to enable or disable "use wrapper for non-annotated List properties"

Since

2.1

setupModule	back to summary
public void setupModule(Module.SetupContext context) Overrides com.fasterxml.jackson.databind.module.SimpleModule.setupModule. Doc from com.fasterxml.jackson.databind.module.SimpleModule.setupModule. Standard implementation handles registration of all configured customizations: it is important that sub-classes call this implementation (usually before additional custom logic) if they choose to override it; otherwise customizations will not be registered. Annotations @SuppressWarnings:deprecation @Override

setupModule

back to summary

public void setupModule(Module.SetupContext context)

Overrides com.fasterxml.jackson.databind.module.SimpleModule.setupModule.

Doc from com.fasterxml.jackson.databind.module.SimpleModule.setupModule.

Standard implementation handles registration of all configured customizations: it is important that sub-classes call this implementation (usually before additional custom logic) if they choose to override it; otherwise customizations will not be registered.

Annotations

@SuppressWarnings:deprecation
@Override

setXMLTextElementName	back to summary
public void setXMLTextElementName(String name) Method that can be used to define alternate "virtual name" to use for XML CDATA segments; that is, text values. Default name is empty String (""); but some frameworks use other names: JAXB, for example, uses "value". Note that method MUST be called before registering the module; otherwise change will not have any effect. Parameters name:String Virtual name to use when exposing XML character data sections Since 2.1

setXMLTextElementName

back to summary

public void setXMLTextElementName(String name)

Method that can be used to define alternate "virtual name" to use for XML CDATA segments; that is, text values. Default name is empty String (""); but some frameworks use other names: JAXB, for example, uses "value".

Note that method MUST be called before registering the module; otherwise change will not have any effect.

Parameters

name:String: Virtual name to use when exposing XML character data sections

Since

2.1

public Class JacksonXmlModule

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail