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

public Interface XmlNameProcessor

extends Serializable
Known Direct Implementers
com.fasterxml.jackson.dataformat.xml.XmlNameProcessors.PassthroughProcessor, com.fasterxml.jackson.dataformat.xml.XmlNameProcessors.ReplaceNameProcessor, com.fasterxml.jackson.dataformat.xml.XmlNameProcessors.Base64NameProcessor, com.fasterxml.jackson.dataformat.xml.XmlNameProcessors.AlwaysOnBase64NameProcessor
Imports
java.io.Serializable
API of processors primarily used for dealing with XML names containing invalid characters. Invalid characters in names can, for instance, easily appear in map keys.

Processors should be set in the XmlMapper#setXmlNameProcessor and/or the XmlMapper.Builder#xmlNameProcessor methods.

See XmlNameProcessors for default processors.

Since
2.14

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XmlNameProcessor.XmlName

Representation of an XML element or attribute name

Method Summary

Modifier and TypeMethod and Description
public void
decodeName(XmlNameProcessor.XmlName
The name to encode
name)

Used during XML deserialization.

public void
encodeName(XmlNameProcessor.XmlName
The name to encode
name)

Used during XML serialization.

Method Detail

decodeNameback to summary
public void decodeName(XmlNameProcessor.XmlName name)

Used during XML deserialization.

This method should process the provided XmlName and revert the encoding done in the encodeName(XmlName) method.

Note

Depending on the use case, it is not always required (or even possible) to reverse an encoding with 100% accuracy.

Parameters
name:XmlNameProcessor.XmlName

The name to encode

encodeNameback to summary
public void encodeName(XmlNameProcessor.XmlName name)

Used during XML serialization.

This method should process the provided XmlName and escape / encode invalid XML characters.

Parameters
name:XmlNameProcessor.XmlName

The name to encode

com.fasterxml.jackson.dataformat.xml back to summary

public Class XmlNameProcessor.XmlName

extends Object
Class Inheritance
  • java.lang.Object
  • com.fasterxml.jackson.dataformat.xml.XmlNameProcessor.XmlName
Representation of an XML element or attribute name

Field Summary

Modifier and TypeField and Description
public String
localPart

public String
namespace

Constructor Summary

AccessConstructor and Description
public
XmlName()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

localPartback to summary
public String localPart
namespaceback to summary
public String namespace

Constructor Detail

XmlNameback to summary
public XmlName()