Jackson Dataformat XML

https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/
Admin
A module for the Jackson data processing library that provides data binding functionality for XML,...
Tokens:29,108
Snippets:476
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Setup Module

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlModule.html

Registers the module with the provided setup context.

```java
public void setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
```

--------------------------------

### Replacement Processor Example

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Demonstrates the output of the replacement processor using an underscore as the replacement string.

```xml
 <DTO>
     <badMap>
         <__I_am__fancy_____>xyz</__I_am__fancy_____>
         <_23>bar</_23>
     </badMap>
 </DTO>
```

--------------------------------

### Write Start Element Method Signature

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlPrettyPrinter.html

Method signature for forcibly writing a start element without updating the Jackson generator's internal element stack.

```java
void writeStartElement(org.codehaus.stax2.XMLStreamWriter2 sw,
                       String nsURI,
                       String localName)
                throws XMLStreamException
```

--------------------------------

### Example XML Output with Base64 Processor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Demonstrates how a map with special characters is serialized when using the base64 name processor.

```xml
 <DTO>
     <badMap>
         <base64_tag_JCBJIGFtIDxmYW5jeT4hICY7>xyz</base64_tag_JCBJIGFtIDxmYW5jeT4hICY7>
         <base64_tag_MTIz>bar</base64_tag_MTIz>
     </badMap>
 </DTO>
```

--------------------------------

### Passthrough Processor Example

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Demonstrates the output of the passthrough processor, which does not sanitize invalid XML names.

```xml
 <DTO>
     <badMap>
         <$ I am <fancy>! &;>xyz</$ I am <fancy>! &;>
         <123>bar</123>
     </badMap>
 </DTO>
```

--------------------------------

### Define XML_START_ELEMENT constant

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Constant representing the start of an XML element.

```java
public static final int XML_START_ELEMENT
```

--------------------------------

### Get location information

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Methods to retrieve the starting or current location of the parser.

```java
public com.fasterxml.jackson.core.JsonLocation currentTokenLocation()
```

```java
public com.fasterxml.jackson.core.JsonLocation currentLocation()
```

```java
@Deprecated
public com.fasterxml.jackson.core.JsonLocation getCurrentLocation()
```

```java
@Deprecated
public com.fasterxml.jackson.core.JsonLocation getTokenLocation()
```

--------------------------------

### Repeat Start Element

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Duplicates the current START_ELEMENT and its matching closing element for virtual wrapping.

```java
protected void repeatStartElement()
```

--------------------------------

### isExpectedStartArrayToken()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Checks if the current start element is expected to represent the start of an array.

```APIDOC
## isExpectedStartArrayToken

### Description
Checks if the current start element is expected to represent the start of an array, as XML does not inherently distinguish between array and object starts.

### Signature
`public boolean isExpectedStartArrayToken()`

### Returns
- **boolean** - True if the current element is expected to be an array.
```

--------------------------------

### Handle Object Lifecycle

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Internal methods for handling the start and end of objects.

```java
public final void _handleStartObject()
                              throws IOException
```

```java
public final void _handleEndObject()
                            throws IOException
```

--------------------------------

### Get parsing context

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Retrieves the current XmlReadContext.

```java
public XmlReadContext getParsingContext()
```

--------------------------------

### writeStartElement

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlPrettyPrinter.html

Forcibly writes a start element to the XML stream without updating the Jackson generator's internal element stack.

```APIDOC
## writeStartElement(XMLStreamWriter2 sw, String nsURI, String localName)

### Description
Method for forcibly writing a start element, without going through Jackson generator (and thus, without updating currently active element stack).

### Parameters
- **sw** (org.codehaus.stax2.XMLStreamWriter2) - The XML stream writer to use.
- **nsURI** (String) - The namespace URI of the element.
- **localName** (String) - The local name of the element.

### Throws
- XMLStreamException
```

--------------------------------

### Write Object Structure

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Methods to start and end an object structure in the XML output.

```java
public final void writeStartObject()
                            throws IOException
```

```java
public final void writeEndObject()
                          throws IOException
```

--------------------------------

### Get State Description

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Returns a description for a specific state integer.

```java
protected String _stateDesc(int state)
```

--------------------------------

### Write Array Structure

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Methods to start and end an array structure in the XML output.

```java
public final void writeStartArray()
                           throws IOException
```

```java
public final void writeEndArray()
                         throws IOException
```

--------------------------------

### Create a Base64 Name Processor with Prefix

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Generates a processor that escapes names containing invalid characters using a specified prefix. Ensure incoming names do not start with the chosen prefix to maintain decoding integrity.

```java
public static XmlNameProcessor newBase64Processor(String prefix)
```

--------------------------------

### Get number value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as a Number.

```java
public Number getNumberValue()
                      throws IOException
```

--------------------------------

### Get Current State Description

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Returns a description of the current stream state.

```java
protected String _currentStateDesc()
```

--------------------------------

### Get current name

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Retrieves the name associated with the current event.

```java
public String currentName()
                   throws IOException
```

```java
@Deprecated
public String getCurrentName()
                                  throws IOException
```

--------------------------------

### Get Serializer Factory Override

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlModule.html

Retrieves the current SerializerFactory override.

```java
public com.fasterxml.jackson.databind.ser.SerializerFactory serializerFactoryOverride()
```

--------------------------------

### Initialization and Configuration Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Methods for initializing the stream and managing format features.

```java
public int initialize()
               throws XMLStreamException
```

```java
public org.codehaus.stax2.XMLStreamReader2 getXmlReader()
```

```java
protected void setFormatFeatures(int f)
```

```java
public int getFormatFeatures()
```

--------------------------------

### createInstance()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.html

Creates a new instance of the pretty printer.

```APIDOC
## public DefaultXmlPrettyPrinter createInstance()

### Description
Creates a new instance of the pretty printer, as specified by the Instantiatable interface.
```

--------------------------------

### Get binary value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Decodes and returns the binary value using the specified Base64 variant.

```java
public byte[] getBinaryValue(com.fasterxml.jackson.core.Base64Variant b64variant)
                      throws IOException
```

--------------------------------

### Create Instance Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlDeserializationContext.html

Methods for creating new instances of the deserialization context with specific configurations.

```java
public com.fasterxml.jackson.databind.deser.DefaultDeserializationContext createInstance(com.fasterxml.jackson.databind.DeserializationConfig config,
                                                                                         com.fasterxml.jackson.core.JsonParser p,
                                                                                         com.fasterxml.jackson.databind.InjectableValues values)
```

```java
public com.fasterxml.jackson.databind.deser.DefaultDeserializationContext createDummyInstance(com.fasterxml.jackson.databind.DeserializationConfig config)
```

--------------------------------

### Get BigDecimal value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as a BigDecimal.

```java
public BigDecimal getDecimalValue()
                           throws IOException
```

--------------------------------

### Get double value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as a double.

```java
public double getDoubleValue()
                      throws IOException
```

--------------------------------

### Build Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Finalizes the configuration and constructs the XmlFactory instance.

```java
public XmlFactory build()
```

--------------------------------

### Getter Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Methods to retrieve current configuration settings from the builder.

```java
public int formatParserFeaturesMask()
```

```java
public int formatGeneratorFeaturesMask()
```

```java
public String nameForTextElement()
```

```java
public XMLInputFactory xmlInputFactory()
```

```java
protected XMLInputFactory defaultInputFactory()
```

```java
public XMLOutputFactory xmlOutputFactory()
```

```java
protected XMLOutputFactory defaultOutputFactory()
```

```java
protected ClassLoader staxClassLoader()
```

```java
public XmlNameProcessor xmlNameProcessor()
```

--------------------------------

### Get float value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as a float.

```java
public float getFloatValue()
                    throws IOException
```

--------------------------------

### Construct XmlInfo Instance

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/XmlInfo.html

Constructor for initializing XML metadata.

```java
public XmlInfo(Boolean isAttribute,
               String ns,
               Boolean isText,
               Boolean isCData)
```

--------------------------------

### Get BigInteger value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as a BigInteger.

```java
public BigInteger getBigIntegerValue()
                              throws IOException
```

--------------------------------

### Get long value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as a long.

```java
public long getLongValue()
                  throws IOException
```

--------------------------------

### Token Navigation Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Methods for advancing the stream and managing token lifecycle.

```java
public int next()
         throws XMLStreamException
```

```java
public void skipEndElement()
                    throws IOException,
                           XMLStreamException
```

```java
public int getCurrentToken()
```

```java
public void closeCompletely()
                     throws XMLStreamException
```

```java
public void close()
           throws XMLStreamException
```

--------------------------------

### Get integer value

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the current numeric value as an int.

```java
public int getIntValue()
                throws IOException
```

--------------------------------

### Init Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/DefaultingXmlTypeResolverBuilder.html

Initializes the type resolver builder with the specified ID type and resolver.

```java
public
com.fasterxml.jackson.databind.jsontype.impl.StdTypeResolverBuilder	init(com.fasterxml.jackson.annotation.JsonTypeInfo.Id	idType,
                                                                                com.fasterxml.jackson.databind.jsontype.TypeIdResolver	idRes)
```

--------------------------------

### withCustomNewLine(String newLine)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.html

Sets a custom new-line character sequence for the pretty printer.

```APIDOC
## public DefaultXmlPrettyPrinter withCustomNewLine(String newLine)

### Description
Sets a custom new-line string to be used in the output. Available since version 2.15.
```

--------------------------------

### Get floating-point number type

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the floating-point number type.

```java
public com.fasterxml.jackson.core.JsonParser.NumberTypeFP getNumberTypeFP()
                                                                   throws IOException
```

--------------------------------

### Parser Configuration and Metadata Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Methods for retrieving version information, managing the ObjectCodec, and checking parser capabilities.

```java
public com.fasterxml.jackson.core.Version version()
```

```java
public com.fasterxml.jackson.core.ObjectCodec getCodec()
```

```java
public void setCodec(com.fasterxml.jackson.core.ObjectCodec c)
```

```java
public void setXMLTextElementName(String name)
```

```java
public boolean requiresCustomCodec()
```

```java
public boolean canReadObjectId()
```

```java
public boolean canReadTypeId()
```

```java
public com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamReadCapability> getReadCapabilities()
```

--------------------------------

### build()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Constructs the final XmlFactory instance based on the current builder configuration.

```APIDOC
## Method: build()

### Description
Finalizes the configuration and returns a new XmlFactory instance.

### Returns
- **XmlFactory** - The configured factory instance.
```

--------------------------------

### Get number type

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the type of the current numeric value.

```java
public com.fasterxml.jackson.core.JsonParser.NumberType getNumberType()
                                                               throws IOException
```

--------------------------------

### Root Context Creation Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlReadContext.html

Static factory methods for creating the root parsing context.

```java
public static XmlReadContext createRootContext(com.fasterxml.jackson.core.json.DupDetector dups,
                                               int lineNr,
                                               int colNr)
```

```java
@Deprecated
public static XmlReadContext createRootContext(int lineNr,
                                                           int colNr)
```

```java
@Deprecated
public static XmlReadContext createRootContext()
```

--------------------------------

### Constructor Definitions

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Constructors for initializing the builder, either as a new instance or based on an existing XmlFactory.

```java
protected XmlFactoryBuilder()
```

```java
public XmlFactoryBuilder(XmlFactory base)
```

--------------------------------

### createInstance(SerializationConfig config, SerializerFactory jsf)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlSerializerProvider.html

Creates a new instance of the serializer provider with the specified configuration and factory.

```APIDOC
### Method
`createInstance(SerializationConfig config, SerializerFactory jsf)`

### Description
Creates a new instance of the serializer provider using the provided SerializationConfig and SerializerFactory.
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlTypeResolverBuilder.XmlMinimalClassNameIdResolver.html

Constructor for initializing the resolver with base type, type factory, subtypes, and validator.

```java
public XmlMinimalClassNameIdResolver(com.fasterxml.jackson.databind.JavaType baseType,
                                     com.fasterxml.jackson.databind.type.TypeFactory typeFactory,
                                     Collection<com.fasterxml.jackson.databind.jsontype.NamedType> subtypes,
                                     com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator ptv)
```

--------------------------------

### Get embedded object

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Retrieves the embedded object associated with the current token.

```java
public Object getEmbeddedObject()
                         throws IOException
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.Lf2SpacesIndenter.html

The default constructor for the Lf2SpacesIndenter class.

```java
public
Lf2SpacesIndenter()
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Initializes a new XmlTokenStream instance.

```java
public XmlTokenStream(XMLStreamReader xmlReader,
                      com.fasterxml.jackson.core.io.ContentReference sourceRef,
                      int formatFeatures,
                      XmlNameProcessor nameProcessor)
```

--------------------------------

### Method Definitions

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/XmlRootNameLookup.html

Core methods for resolving root names and handling serialization state.

```java
protected Object readResolve()
```

```java
public QName findRootName(com.fasterxml.jackson.databind.JavaType rootType,
                          com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)
```

```java
public QName findRootName(Class<?> rootType,
                          com.fasterxml.jackson.databind.cfg.MapperConfig<?> config)
```

```java
protected QName _findRootName(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config,
                              Class<?> rootType)
```

--------------------------------

### Context Configuration Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlDeserializationContext.html

Methods to configure the deserialization context with factories or cache providers.

```java
public com.fasterxml.jackson.databind.deser.DefaultDeserializationContext with(com.fasterxml.jackson.databind.deser.DeserializerFactory factory)
```

```java
public com.fasterxml.jackson.databind.deser.DefaultDeserializationContext withCaches(com.fasterxml.jackson.databind.cfg.CacheProvider cp)
```

--------------------------------

### XML Configuration Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.Builder.html

Methods for setting XML-specific behaviors like text element naming, wrapper usage, and name processing.

```java
public	XmlMapper.Builder	nameForTextElement(String	name)
```

```java
public	XmlMapper.Builder	defaultUseWrapper(boolean	state)
```

```java
public	XmlMapper.Builder	xmlNameProcessor(XmlNameProcessor	processor)
```

--------------------------------

### JacksonXmlModule()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlModule.html

Constructs a new JacksonXmlModule instance.

```APIDOC
## JacksonXmlModule()

### Description
Constructs a new instance of the JacksonXmlModule.
```

--------------------------------

### JacksonXmlModule()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlModule.html

Constructor for creating a new JacksonXmlModule instance.

```APIDOC
## JacksonXmlModule()

### Description
Constructs a new JacksonXmlModule instance.
```

--------------------------------

### Implement addVirtualWrapping Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/ElementWrappable.html

Method signature for configuring auto-wrapping of specific XML element names.

```java
void addVirtualWrapping(Set<String> namesToWrap0,
                        boolean caseInsensitive)
```

--------------------------------

### FromXmlParser Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Constructors for initializing the XML parser with I/O context, features, and codec settings.

```java
public FromXmlParser(com.fasterxml.jackson.core.io.IOContext ctxt,
                     int genericParserFeatures,
                     int xmlFeatures,
                     com.fasterxml.jackson.core.ObjectCodec codec,
                     XMLStreamReader xmlReader,
                     XmlNameProcessor tagProcessor)
              throws IOException
```

```java
public FromXmlParser(com.fasterxml.jackson.core.io.IOContext ctxt,
                     int genericParserFeatures,
                     com.fasterxml.jackson.core.ObjectCodec codec,
                     XmlTokenStream xmlTokenStream)
              throws IOException
```

--------------------------------

### newBase64Processor(String prefix)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that escapes invalid XML name characters using base64 encoding.

```APIDOC
## newBase64Processor(String prefix)

### Description
Generates a new processor that escapes all names containing characters invalid for XML elements/attributes with a base64-encoded version.

### Parameters
- **prefix** (String) - The prefix to prepend to the base64 encoded string.

### Signature
`public static XmlNameProcessor newBase64Processor(String prefix)`
```

--------------------------------

### XmlName()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessor.XmlName.html

Constructor for creating an instance of XmlName.

```APIDOC
## Constructor: XmlName()

### Description
Constructs a new instance of the XmlName class.

### Signature
`public XmlName()`
```

--------------------------------

### XmlMapper()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Constructs a new XmlMapper instance with default XML module and factory settings.

```APIDOC
## XmlMapper()

### Description
Creates a new instance of XmlMapper using default settings for XML input and output factories.

### Constructor
`public XmlMapper()`
```

--------------------------------

### XmlMapper.builder()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/class-use/XmlMapper.Builder.html

Creates a new instance of XmlMapper.Builder.

```APIDOC
## XmlMapper.builder()

### Description
Creates a new builder instance for configuring an XmlMapper.

### Method
static XmlMapper.Builder builder()
```

--------------------------------

### initGenerator

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Initializes the generator, optionally outputting the XML declaration.

```APIDOC
## void initGenerator()

### Description
Method called before writing any other output, to optionally output XML declaration.

### Throws
- IOException
```

--------------------------------

### Parser lifecycle and state management methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Methods for handling EOF, buffer release, and token navigation.

```java
protected void _handleEOF()
                   throws com.fasterxml.jackson.core.JsonParseException
```

```java
protected void _releaseBuffers()
                        throws IOException
```

```java
protected com.fasterxml.jackson.core.util.ByteArrayBuilder _getByteArrayBuilder()
```

```java
protected int _nextToken()
                  throws IOException
```

```java
protected void _skipEndElement()
                        throws IOException
```

--------------------------------

### newBase64Processor()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that escapes names using a default base64 prefix.

```APIDOC
## public static XmlNameProcessor newBase64Processor()

### Description
Convenience method equivalent to calling newBase64Processor(String) with the default prefix "base64_tag_".
```

--------------------------------

### Builder Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Static factory methods to create an XmlMapper.Builder instance.

```APIDOC
## Static Methods

- `public static XmlMapper.Builder xmlBuilder()`
- `public static XmlMapper.Builder builder()`
- `public static XmlMapper.Builder builder(XmlFactory streamFactory)`
```

--------------------------------

### Initialize XmlBeanPropertyWriter

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanPropertyWriter.html

Constructors for creating an XmlBeanPropertyWriter instance, optionally providing a custom serializer.

```java
public XmlBeanPropertyWriter(com.fasterxml.jackson.databind.ser.BeanPropertyWriter wrapped,
                             com.fasterxml.jackson.databind.PropertyName wrapperName,
                             com.fasterxml.jackson.databind.PropertyName wrappedName)
```

```java
public XmlBeanPropertyWriter(com.fasterxml.jackson.databind.ser.BeanPropertyWriter wrapped,
                             com.fasterxml.jackson.databind.PropertyName wrapperName,
                             com.fasterxml.jackson.databind.PropertyName wrappedName,
                             com.fasterxml.jackson.databind.JsonSerializer<Object> serializer)
```

--------------------------------

### newBase64Processor(String prefix)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that escapes names containing invalid characters using a base64-encoded version with a specified prefix.

```APIDOC
## public static XmlNameProcessor newBase64Processor(String prefix)

### Description
Generates a new processor that escapes all names containing characters other than standard ASCII letters, digits, underscores, hyphens, or colons using a base64-encoded version. The base64url encoder is used, and padding characters are omitted.

### Parameters
- **prefix** (String) - Required - The prefix to use for names that are escaped. Ensure no incoming element or attribute name starts with this prefix to avoid decoding issues.
```

--------------------------------

### XmlMapper Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Constructors for initializing an XmlMapper instance.

```APIDOC
## Constructors

- `XmlMapper(JacksonXmlModule module)`
- `XmlMapper(XmlFactory xmlFactory, JacksonXmlModule module)`
- `protected XmlMapper(XmlMapper src)`
```

--------------------------------

### version Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/PackageVersion.html

Retrieves the version of the package as defined by the Versioned interface.

```java
public com.fasterxml.jackson.core.Version version()
```

--------------------------------

### Manage serialization behavior

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/UnwrappingXmlBeanSerializer.html

Methods for configuring and executing the serialization process, including unwrapping logic and property filtering.

```java
public com.fasterxml.jackson.databind.JsonSerializer<Object> unwrappingSerializer(com.fasterxml.jackson.databind.util.NameTransformer transformer)
```

```java
public boolean isUnwrappingSerializer()
```

```java
public com.fasterxml.jackson.databind.ser.std.BeanSerializerBase withObjectIdWriter(com.fasterxml.jackson.databind.ser.impl.ObjectIdWriter objectIdWriter)
```

```java
public com.fasterxml.jackson.databind.ser.std.BeanSerializerBase withFilterId(Object filterId)
```

```java
protected com.fasterxml.jackson.databind.ser.std.BeanSerializerBase withByNameInclusion(Set<String> toIgnore,
                                                                                        Set<String> toInclude)
```

```java
protected com.fasterxml.jackson.databind.ser.std.BeanSerializerBase withProperties(com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] properties,
                                                                                   com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] filteredProperties)
```

```java
protected com.fasterxml.jackson.databind.ser.std.BeanSerializerBase asArraySerializer()
```

```java
public final void serialize(Object bean,
                            com.fasterxml.jackson.core.JsonGenerator jgen,
                            com.fasterxml.jackson.databind.SerializerProvider provider)
                     throws IOException,
                            com.fasterxml.jackson.core.JsonGenerationException
```

```java
public String toString()
```

--------------------------------

### copy()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlSerializerProvider.html

Creates a copy of the current serializer provider instance.

```APIDOC
### Method
`copy()`

### Description
Creates a copy of the current serializer provider instance, maintaining the configuration of the original provider.
```

--------------------------------

### Define XML wrapper and wrapped QNames

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanPropertyWriter.html

Protected fields representing the XML element names for collection wrappers and individual items.

```java
protected final QName _wrapperQName
```

```java
protected final QName _wrappedQName
```

--------------------------------

### XmlDeserializationContext Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlDeserializationContext.html

Initializes a new blueprint object using the provided DeserializerFactory.

```java
public XmlDeserializationContext(com.fasterxml.jackson.databind.deser.DeserializerFactory df)
```

--------------------------------

### newAlwaysOnBase64Processor()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that forces base64 encoding for all names.

```APIDOC
## public static XmlNameProcessor newAlwaysOnBase64Processor()

### Description
Creates a processor where all names are always escaped with base64. No prefix is required for this processor as all names are encoded.
```

--------------------------------

### Define _nextName

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

The QName to be used for the next output operation.

```java
protected QName _nextName
```

--------------------------------

### PackageVersion Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/PackageVersion.html

The default constructor for the PackageVersion class.

```java
public PackageVersion()
```

--------------------------------

### Initialize XmlBeanSerializer with Source

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanSerializer.html

Constructor used to create an XmlBeanSerializer from an existing BeanSerializerBase instance.

```java
public XmlBeanSerializer(com.fasterxml.jackson.databind.ser.std.BeanSerializerBase src)
```

--------------------------------

### XmlMapper.Builder.configure()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/class-use/XmlMapper.Builder.html

Configures specific XML parser or generator features.

```APIDOC
## XmlMapper.Builder.configure(Feature feature, boolean state)

### Description
Configures the state of a specific FromXmlParser.Feature or ToXmlGenerator.Feature.

### Parameters
- **feature** (FromXmlParser.Feature/ToXmlGenerator.Feature) - The feature to configure.
- **state** (boolean) - The desired state of the feature.
```

--------------------------------

### isOutputAsText(MapperConfig<?> config, Annotated ann)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlAnnotationIntrospector.Pair.html

Determines if the annotated element should be output as XML text.

```APIDOC
## public Boolean isOutputAsText(MapperConfig<?> config, Annotated ann)

### Description
Checks if the specified annotated element is configured to be serialized as XML text content.

### Parameters
- **config** (MapperConfig<?>) - The mapper configuration.
- **ann** (Annotated) - The annotated element to inspect.
```

--------------------------------

### Initialize Stax2JacksonReaderAdapter

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/Stax2JacksonReaderAdapter.html

Constructor for creating a new adapter instance from an existing XMLStreamReader.

```java
public Stax2JacksonReaderAdapter(XMLStreamReader sr)
```

--------------------------------

### Context State Management Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlReadContext.html

Methods for resetting context state and managing current values.

```java
protected final void reset(int type,
                           int lineNr,
                           int colNr)
```

```java
public Object getCurrentValue()
```

```java
public void setCurrentValue(Object v)
```

--------------------------------

### Initialize XmlBeanSerializerBase

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanSerializerBase.html

Constructors for creating instances of XmlBeanSerializerBase with various configuration options like property filtering, name transformation, or property arrays.

```java
protected XmlBeanSerializerBase(XmlBeanSerializerBase src,
                                Set<String> toIgnore,
                                Set<String> toInclude)
```

```java
public XmlBeanSerializerBase(XmlBeanSerializerBase src,
                             com.fasterxml.jackson.databind.util.NameTransformer transformer)
```

```java
protected XmlBeanSerializerBase(XmlBeanSerializerBase src,
                                com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] properties,
                                com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] filteredProperties)
```

--------------------------------

### DefaultXmlPrettyPrinter()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.html

Constructs a new DefaultXmlPrettyPrinter instance.

```APIDOC
## public DefaultXmlPrettyPrinter()

### Description
Constructs a new instance of the DefaultXmlPrettyPrinter.
```

--------------------------------

### _cfgNameForTextElement Configuration

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Defines the property name used for pseudo-properties when an element contains both attributes and text.

```java
protected String _cfgNameForTextElement
```

--------------------------------

### Create a Default Base64 Name Processor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Convenience method that initializes a base64 processor using the default prefix 'base64_tag_'.

```java
public static XmlNameProcessor newBase64Processor()
```

--------------------------------

### Constructor Definition

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/XmlRootNameLookup.html

The default constructor for the lookup utility.

```java
public XmlRootNameLookup()
```

--------------------------------

### newPassthroughProcessor()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that performs no escaping, passing names through as-is. Note that this may result in invalid XML if names contain illegal characters.

```APIDOC
## newPassthroughProcessor()

### Description
Generates a new processor that does nothing and just passes through the names as-is. This is the default behavior for backwards compatibility.

### Signature
`public static XmlNameProcessor newPassthroughProcessor()`
```

--------------------------------

### Initialize ToXmlGenerator

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Constructor for creating a new ToXmlGenerator instance with the specified context, features, codec, and writer.

```java
public ToXmlGenerator(com.fasterxml.jackson.core.io.IOContext ctxt,
                      int stdFeatures,
                      int xmlFeatures,
                      com.fasterxml.jackson.core.ObjectCodec codec,
                      XMLStreamWriter sw,
                      XmlNameProcessor nameProcessor)
```

--------------------------------

### Copy Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlDeserializationContext.html

Creates a copy of the current deserialization context.

```java
public XmlDeserializationContext copy()
```

--------------------------------

### WrapperHandlingDeserializer Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/WrapperHandlingDeserializer.html

Core methods for delegating instance creation, contextual deserialization, and value deserialization.

```java
protected com.fasterxml.jackson.databind.JsonDeserializer<?> newDelegatingInstance(com.fasterxml.jackson.databind.JsonDeserializer<?> newDelegatee0)
```

```java
public com.fasterxml.jackson.databind.JsonDeserializer<?> createContextual(com.fasterxml.jackson.databind.DeserializationContext ctxt,
                                                                           com.fasterxml.jackson.databind.BeanProperty property)
                                                                    throws com.fasterxml.jackson.databind.JsonMappingException
```

```java
public Object deserialize(com.fasterxml.jackson.core.JsonParser p,
                          com.fasterxml.jackson.databind.DeserializationContext ctxt)
                   throws IOException
```

```java
public Object deserialize(com.fasterxml.jackson.core.JsonParser p,
                          com.fasterxml.jackson.databind.DeserializationContext ctxt,
                          Object intoValue)
                   throws IOException
```

--------------------------------

### Field Definitions

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/XmlRootNameLookup.html

Definitions for the static and protected fields used for root name management.

```java
public static final QName ROOT_NAME_FOR_NULL
```

```java
protected final transient com.fasterxml.jackson.databind.util.LRUMap<com.fasterxml.jackson.databind.type.ClassKey,QName> _rootNames
```

--------------------------------

### WrapperHandlingDeserializer Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/WrapperHandlingDeserializer.html

Constructors for initializing the deserializer with a delegate and optional names to wrap.

```java
public WrapperHandlingDeserializer(com.fasterxml.jackson.databind.deser.BeanDeserializerBase delegate)
```

```java
public WrapperHandlingDeserializer(com.fasterxml.jackson.databind.deser.BeanDeserializerBase delegate,
                                   Set<String> namesToWrap)
```

--------------------------------

### NopIndenter Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.NopIndenter.html

The constructor for the NopIndenter class.

```java
public NopIndenter()
```

--------------------------------

### XmlMapper Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

The XmlMapper class provides several constructors to initialize the mapper with specific modules, factories, or default settings.

```APIDOC
## Constructors

- `XmlMapper()`: Creates a default XmlMapper instance.
- `XmlMapper(JacksonXmlModule module)`: Creates an XmlMapper with a specific JacksonXmlModule.
- `XmlMapper(XmlFactory xmlFactory)`: Creates an XmlMapper using a custom XmlFactory.
- `XmlMapper(XmlFactory xmlFactory, JacksonXmlModule module)`: Creates an XmlMapper with both a custom factory and module.
- `XmlMapper(XMLInputFactory inputF)`: Creates an XmlMapper using a specific XMLInputFactory.
- `XmlMapper(XMLInputFactory inputF, XMLOutputFactory outF)`: Creates an XmlMapper using specific input and output factories.
```

--------------------------------

### Constructor Definition

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/DefaultingXmlTypeResolverBuilder.html

Constructor for initializing the builder with default typing settings and a polymorphic type validator.

```java
public
DefaultingXmlTypeResolverBuilder(com.fasterxml.jackson.databind.ObjectMapper.DefaultTyping	t,
                                        com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator	ptv)
```

--------------------------------

### Constructor Definition

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessor.XmlName.html

The default constructor for the XmlName class.

```java
public XmlName()
```

--------------------------------

### Configuration Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Methods for enabling, disabling, or configuring XML parser and generator features.

```APIDOC
## Method: enable/disable/configure

### Description
Fluent methods to modify the state of FromXmlParser.Feature or ToXmlGenerator.Feature settings.

### Methods
- `enable(FromXmlParser.Feature f)`
- `disable(FromXmlParser.Feature f)`
- `configure(FromXmlParser.Feature f, boolean state)`
- `enable(ToXmlGenerator.Feature f)`
- `disable(ToXmlGenerator.Feature f)`
- `configure(ToXmlGenerator.Feature f, boolean state)`
```

--------------------------------

### startWrappedValue

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Called when a structured collection, array, or map is being output.

```APIDOC
## void startWrappedValue(QName wrapperName, QName wrappedName)

### Description
Method called when a structured (collection, array, map) is being output.

### Parameters
- **wrapperName** (QName) - Element used as wrapper around elements, if any (null if none)
- **wrappedName** (QName) - Element used around individual content items (can not be null)

### Throws
- IOException
```

--------------------------------

### withProperties Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanSerializer.html

Returns a copy of the serializer with updated property writers.

```java
protected com.fasterxml.jackson.databind.ser.std.BeanSerializerBase withProperties(com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] properties,
                                                                                   com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] filteredProperties)
```

--------------------------------

### serialize Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanSerializer.html

Performs the main serialization process by delegating output to configured BeanPropertyWriter instances.

```java
public void serialize(Object bean,
                      com.fasterxml.jackson.core.JsonGenerator g,
                      com.fasterxml.jackson.databind.SerializerProvider provider)
               throws IOException
```

--------------------------------

### Construct XmlTextDeserializer

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTextDeserializer.html

Constructors for initializing the deserializer with a delegate and either a property or an index.

```java
public XmlTextDeserializer(com.fasterxml.jackson.databind.deser.BeanDeserializerBase delegate,
                           com.fasterxml.jackson.databind.deser.SettableBeanProperty prop)
```

```java
public XmlTextDeserializer(com.fasterxml.jackson.databind.deser.BeanDeserializerBase delegate,
                           int textPropIndex)
```

--------------------------------

### Size Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/CaseInsensitiveNameSet.html

Returns the number of elements in the set.

```java
public int size()
```

--------------------------------

### Construct XmlTypeResolverBuilder instances

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlTypeResolverBuilder.html

Constructors for initializing the XmlTypeResolverBuilder.

```java
public XmlTypeResolverBuilder()
```

```java
public XmlTypeResolverBuilder(com.fasterxml.jackson.annotation.JsonTypeInfo.Value settings)
```

--------------------------------

### Accessor Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.html

Methods to retrieve information about the current token.

```java
public String getText()
```

```java
public String getLocalName()
```

```java
public String getNamespaceURI()
```

```java
public boolean hasXsiNil()
```

```java
public com.fasterxml.jackson.core.JsonLocation getCurrentLocation()
```

--------------------------------

### XmlMapper(XMLInputFactory, XMLOutputFactory)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Constructs a new XmlMapper instance with custom XML input and output factories.

```APIDOC
## XmlMapper(XMLInputFactory inputF, XMLOutputFactory outF)

### Description
Creates a new instance of XmlMapper with specific XML input and output factories provided by the user.

### Constructor
`public XmlMapper(XMLInputFactory inputF, XMLOutputFactory outF)`
```

--------------------------------

### Iterate over FromXmlParser.Feature constants

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.Feature.html

Demonstrates how to iterate through all defined enum constants using the values() method.

```java
for (FromXmlParser.Feature c : FromXmlParser.Feature.values())
   System.out.println(c);
```

--------------------------------

### newReplacementProcessor(String replacement)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that replaces invalid XML name characters with a specified replacement string.

```APIDOC
## newReplacementProcessor(String replacement)

### Description
Generates a new processor that replaces all characters that are not valid for XML names with a provided replacement string.

### Parameters
- **replacement** (String) - The replacement string to use for invalid characters.

### Signature
`public static XmlNameProcessor newReplacementProcessor(String replacement)`
```

--------------------------------

### Context Modification and Utility Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlReadContext.html

Methods for updating context state, setting names, and string representation.

```java
public final void valueStarted()
```

```java
public void setCurrentName(String name)
                    throws com.fasterxml.jackson.core.JsonProcessingException
```

```java
public void setNamesToWrap(Set<String> namesToWrap)
```

```java
public boolean shouldWrap(String localName)
```

```java
protected void convertToArray()
```

```java
public final String toString()
```

--------------------------------

### XmlMapper(XMLInputFactory)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Constructs a new XmlMapper instance with a custom XML input factory.

```APIDOC
## XmlMapper(XMLInputFactory inputF)

### Description
Creates a new instance of XmlMapper using the provided XML input factory.

### Constructor
`public XmlMapper(XMLInputFactory inputF)`
```

--------------------------------

### XmlMapper.Builder Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.Builder.html

Constructor for initializing the builder with an existing XmlMapper instance.

```java
public	Builder(XmlMapper	m)
```

--------------------------------

### XmlMapper Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Various constructors for initializing an XmlMapper, allowing for custom XML input/output factories or a specific XmlFactory.

```java
public XmlMapper()
```

```java
public XmlMapper(XMLInputFactory inputF,
                 XMLOutputFactory outF)
```

```java
public XmlMapper(XMLInputFactory inputF)
```

```java
public XmlMapper(XmlFactory xmlFactory)
```

--------------------------------

### Configure virtual wrapping

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Indicates that specified names should be considered for auto-wrapping to support unwrapped array types.

```java
public void addVirtualWrapping(Set<String> namesToWrap0,
                               boolean caseInsensitive)
```

--------------------------------

### Configure Parser

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/WrapperHandlingDeserializer.html

Internal method for configuring the JsonParser instance.

```java
protected final void _configureParser(com.fasterxml.jackson.core.JsonParser p)
                               throws IOException
```

--------------------------------

### Set Default Use Wrapper

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlModule.html

Configures whether to use wrappers for non-annotated indexed properties. Must be called before module registration.

```java
public void setDefaultUseWrapper(boolean state)
```

--------------------------------

### Construct JacksonXmlModule

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlModule.html

Default constructor for the JacksonXmlModule.

```java
public JacksonXmlModule()
```

--------------------------------

### FromXmlParser(IOContext, int, int, ObjectCodec, XMLStreamReader, XmlNameProcessor)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Constructs a new FromXmlParser instance using the provided IO context, parser features, XML features, codec, XML stream reader, and tag processor.

```APIDOC
## FromXmlParser(IOContext ctxt, int genericParserFeatures, int xmlFeatures, ObjectCodec codec, XMLStreamReader xmlReader, XmlNameProcessor tagProcessor)

### Description
Constructs a new FromXmlParser instance using the provided XML stream reader and configuration components.

### Parameters
- **ctxt** (IOContext) - The IO context for the parser.
- **genericParserFeatures** (int) - Bitmask of generic Jackson parser features.
- **xmlFeatures** (int) - Bitmask of XML-specific parser features.
- **codec** (ObjectCodec) - The object codec to use for data binding.
- **xmlReader** (XMLStreamReader) - The underlying XML stream reader.
- **tagProcessor** (XmlNameProcessor) - The processor for handling XML tag names.
```

--------------------------------

### FromXmlParser(IOContext, int, ObjectCodec, XmlTokenStream)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Constructs a new FromXmlParser instance using the provided XML token stream.

```APIDOC
## FromXmlParser(IOContext ctxt, int genericParserFeatures, ObjectCodec codec, XmlTokenStream xmlTokenStream)

### Description
Constructs a new FromXmlParser instance using the provided XML token stream for parsing.

### Parameters
- **ctxt** (IOContext) - The IO context for the parser.
- **genericParserFeatures** (int) - Bitmask of generic Jackson parser features.
- **codec** (ObjectCodec) - The object codec to use for data binding.
- **xmlTokenStream** (XmlTokenStream) - The XML token stream to be parsed.
```

--------------------------------

### Parser Feature Configuration Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.Builder.html

Methods for enabling, disabling, or configuring FromXmlParser features.

```java
public	XmlMapper.Builder	enable(FromXmlParser.Feature...	features)
```

```java
public	XmlMapper.Builder	disable(FromXmlParser.Feature...	features)
```

```java
public	XmlMapper.Builder	configure(FromXmlParser.Feature	feature,
                                   boolean	state)
```

--------------------------------

### nextToken()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Advances the parser to the next token in the XML stream.

```APIDOC
## nextToken

### Description
Advances the parser to the next token in the XML stream.

### Signature
`public com.fasterxml.jackson.core.JsonToken nextToken() throws IOException`

### Returns
- **JsonToken** - The next token found in the stream.
```

--------------------------------

### Default XML Module and Pretty Printer Fields

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

These protected static fields define the default module and pretty printer used by the XmlMapper.

```java
protected static final JacksonXmlModule DEFAULT_XML_MODULE
```

```java
protected static final DefaultXmlPrettyPrinter DEFAULT_XML_PRETTY_PRINTER
```

--------------------------------

### XmlReadContext Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlReadContext.html

Constructors for initializing the parsing context, including a deprecated version.

```java
public XmlReadContext(XmlReadContext parent,
                      com.fasterxml.jackson.core.json.DupDetector dups,
                      int nestingDepth,
                      int type,
                      int lineNr,
                      int colNr)
```

```java
@Deprecated
public XmlReadContext(XmlReadContext parent,
                                  int nestingDepth,
                                  int type,
                                  int lineNr,
                                  int colNr)
```

--------------------------------

### Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.FixedSpaceIndenter.html

The default constructor for the FixedSpaceIndenter class.

```java
public FixedSpaceIndenter()
```

--------------------------------

### Create an Always-On Base64 Name Processor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

Creates a processor that forces base64 encoding for all names, eliminating the need for a prefix.

```java
public static XmlNameProcessor newAlwaysOnBase64Processor()
```

--------------------------------

### Iterate over ToXmlGenerator.Feature constants

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.Feature.html

Demonstrates how to retrieve and iterate over all defined enum constants.

```java
public static ToXmlGenerator.Feature[] values()
```

```java
for (ToXmlGenerator.Feature c : ToXmlGenerator.Feature.values())
    System.out.println(c);
```

--------------------------------

### Method Signatures for XmlNameProcessors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlNameProcessors.html

The method signatures for the various processor factory methods available in the class.

```java
public static XmlNameProcessor newPassthroughProcessor()
```

```java
public static XmlNameProcessor newReplacementProcessor(String replacement)
```

```java
public static XmlNameProcessor newReplacementProcessor()
```

--------------------------------

### XmlMapper(XmlFactory)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

Constructs a new XmlMapper instance with a custom XmlFactory.

```APIDOC
## XmlMapper(XmlFactory xmlFactory)

### Description
Creates a new instance of XmlMapper using the provided XmlFactory instance.

### Constructor
`public XmlMapper(XmlFactory xmlFactory)`
```

--------------------------------

### Construct Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/CaseInsensitiveNameSet.html

Static factory method to create a new CaseInsensitiveNameSet from an existing set of names.

```java
public static CaseInsensitiveNameSet construct(Set<String> names0)
```

--------------------------------

### AnnotationUtil Constructor

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/AnnotationUtil.html

The default constructor for the AnnotationUtil class.

```java
public
AnnotationUtil()
```

--------------------------------

### XmlMapper.Builder

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

The Builder class provides a fluent API for constructing and configuring XmlMapper instances.

```APIDOC
## XmlMapper.Builder

### Description
Static nested class used for constructing `XmlMapper` instances using a builder pattern.
```

--------------------------------

### Setter Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Methods to configure builder properties, including deprecated methods for factory settings.

```java
public XmlFactoryBuilder nameForTextElement(String name)
```

```java
public XmlFactoryBuilder xmlInputFactory(XMLInputFactory xmlIn)
```

```java
public XmlFactoryBuilder xmlOutputFactory(XMLOutputFactory xmlOut)
```

```java
@Deprecated
public XmlFactoryBuilder inputFactory(XMLInputFactory xmlIn)
```

```java
@Deprecated
public XmlFactoryBuilder outputFactory(XMLOutputFactory xmlOut)
```

```java
public XmlFactoryBuilder staxClassLoader(ClassLoader cl)
```

```java
public XmlFactoryBuilder xmlNameProcessor(XmlNameProcessor nameProcessor)
```

--------------------------------

### toString Method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanSerializer.html

Returns a string representation of the serializer.

```java
public String toString()
```

--------------------------------

### Create new delegating instance

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlTextDeserializer.html

Creates a new instance of the deserializer with a specific delegatee.

```java
protected com.fasterxml.jackson.databind.JsonDeserializer<?> newDelegatingInstance(com.fasterxml.jackson.databind.JsonDeserializer<?> newDelegatee0)
```

--------------------------------

### Access the DEFAULT_USE_WRAPPER constant

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/JacksonXmlAnnotationIntrospector.html

This constant defines the default behavior for XML wrapper usage.

```java
public static final boolean DEFAULT_USE_WRAPPER
```

--------------------------------

### WrapperHandlingDeserializer Fields

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/WrapperHandlingDeserializer.html

Fields defining the wrapping configuration, target type, and case sensitivity settings.

```java
protected final Set<String> _namesToWrap
```

```java
protected final com.fasterxml.jackson.databind.JavaType _type
```

```java
protected final boolean _caseInsensitive
```

--------------------------------

### Access _propName method

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlTypeResolverBuilder.html

Method used to process property names for XML compatibility.

```java
protected String _propName(String propName,
                           com.fasterxml.jackson.annotation.JsonTypeInfo.Id idType)
```

--------------------------------

### addVirtualWrapping(Set<String> namesToWrap0, boolean caseInsensitive)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Indicates that specified names should be considered 'auto-wrapping', meaning they will be doubled to contain two opening and two matching closing elements. This supports handling of 'unwrapped' array types.

```APIDOC
## addVirtualWrapping

### Description
Indicates that specified names should be considered 'auto-wrapping', meaning they will be doubled to contain two opening and two matching closing elements. This supports handling of 'unwrapped' array types.

### Signature
`public void addVirtualWrapping(Set<String> namesToWrap0, boolean caseInsensitive)`

### Parameters
- **namesToWrap0** (Set<String>) - The set of local names to be wrapped.
- **caseInsensitive** (boolean) - Whether the name matching should be case-insensitive.
```

--------------------------------

### Retrieve text content

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.html

Returns the textual content of the current token.

```java
public String getText()
               throws IOException
```

--------------------------------

### Define _initialized

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Marker indicating if initGenerator has been called, available since 2.2.

```java
protected boolean _initialized
```

--------------------------------

### XmlFactoryBuilder(XmlFactory base)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.html

Constructs a new builder instance based on an existing XmlFactory.

```APIDOC
## Constructor: XmlFactoryBuilder(XmlFactory base)

### Description
Creates a new builder instance initialized with the settings from the provided base XmlFactory.

### Parameters
- **base** (XmlFactory) - Required - The base factory to copy settings from.
```

--------------------------------

### Child Context Creation Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/deser/XmlReadContext.html

Methods to create child contexts for arrays or objects.

```java
public final XmlReadContext createChildArrayContext(int lineNr,
                                                    int colNr)
```

```java
public final XmlReadContext createChildObjectContext(int lineNr,
                                                     int colNr)
```

--------------------------------

### Access XmlInfo Methods

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/XmlInfo.html

Getter methods for retrieving XML metadata properties.

```java
public String getNamespace()
```

```java
public boolean isAttribute()
```

```java
public boolean isText()
```

```java
public boolean isCData()
```

--------------------------------

### next()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/Stax2JacksonReaderAdapter.html

Advances the XML stream reader to the next event in the XML document.

```APIDOC
## Method: next()

### Description
Advances the reader to the next event in the XML stream.

### Returns
- **int** - The event type code.

### Throws
- **XMLStreamException** - If an error occurs while reading the next event.
```

--------------------------------

### enabledByDefault()

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.Feature.html

Checks if the specific feature is enabled by default.

```APIDOC
### boolean enabledByDefault()

#### Description
Checks whether this specific feature is enabled by default.

#### Returns
- **boolean** - True if enabled by default, false otherwise.
```

--------------------------------

### instance(AnnotationIntrospector a1, AnnotationIntrospector a2)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlAnnotationIntrospector.Pair.html

Creates a new Pair instance combining two AnnotationIntrospectors.

```APIDOC
## public static XmlAnnotationIntrospector.Pair instance(AnnotationIntrospector a1, AnnotationIntrospector a2)

### Description
Creates a new Pair instance that combines two provided AnnotationIntrospector instances.

### Parameters
- **a1** (AnnotationIntrospector) - The first introspector.
- **a2** (AnnotationIntrospector) - The second introspector.
```

--------------------------------

### XML Module Instance Field

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/XmlMapper.html

The internal XML module instance used by the mapper.

```java
protected final JacksonXmlModule _xmlModule
```

--------------------------------

### Access XmlInfo Fields

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/XmlInfo.html

Field definitions for XML metadata.

```java
protected final String _namespace
```

```java
protected final boolean _isAttribute
```

```java
protected final boolean _isText
```

```java
protected final boolean _isCData
```

--------------------------------

### Write binary data to XML

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Methods for writing binary data using a specified Base64 variant.

```java
public void writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
                        byte[] data,
                        int offset,
                        int len)
                 throws IOException
```

```java
public int writeBinary(com.fasterxml.jackson.core.Base64Variant b64variant,
                       InputStream data,
                       int dataLength)
                throws IOException
```

--------------------------------

### Class Declaration

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.Lf2SpacesIndenter.html

The class definition for Lf2SpacesIndenter, which implements the Indenter interface.

```java
protected class DefaultXmlPrettyPrinter.Lf2SpacesIndenter
extends Object
implements DefaultXmlPrettyPrinter.Indenter, Serializable
```

--------------------------------

### VERSION Field Declaration

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/PackageVersion.html

The static final field containing the version information for the package.

```java
public static final com.fasterxml.jackson.core.Version VERSION
```

--------------------------------

### Check for Text Output Configuration

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/jaxb/XmlJaxbAnnotationIntrospector.html

Determines if the annotated element should be serialized as text. This method is deprecated.

```java
public Boolean isOutputAsText(com.fasterxml.jackson.databind.cfg.MapperConfig<?> config,
                              com.fasterxml.jackson.databind.introspect.Annotated ann)
```

--------------------------------

### Write Raw Content

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/ToXmlGenerator.html

Methods to write raw text content directly to the output.

```java
public void writeRaw(String text)
              throws IOException
```

```java
public void writeRaw(String text,
                     int offset,
                     int len)
              throws IOException
```

--------------------------------

### Write Prolog Linefeed

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/DefaultXmlPrettyPrinter.html

Writes a linefeed to separate entities outside of the root element, such as between the XML declaration and the root element.

```java
public void writePrologLinefeed(org.codehaus.stax2.XMLStreamWriter2 sw)
                         throws XMLStreamException
```

--------------------------------

### CaseInsensitiveNameSet.construct(Set<String> names0)

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/util/class-use/CaseInsensitiveNameSet.html

Constructs a new CaseInsensitiveNameSet from a provided set of names.

```APIDOC
## CaseInsensitiveNameSet.construct

### Description
Creates a new instance of CaseInsensitiveNameSet using the provided set of strings.

### Signature
`public static CaseInsensitiveNameSet construct(Set<String> names0)`

### Parameters
- **names0** (Set<String>) - The set of names to be included in the case-insensitive set.
```

--------------------------------

### XmlBeanSerializer Constructors

Source: https://javadoc.io/doc/com.fasterxml.jackson.dataformat/jackson-dataformat-xml/2.22.1/com/fasterxml/jackson/dataformat/xml/ser/XmlBeanSerializer.html

Constructors for initializing XmlBeanSerializer with different configurations for object IDs, property filtering, and property arrays.

```java
public XmlBeanSerializer(XmlBeanSerializerBase src,
                         com.fasterxml.jackson.databind.ser.impl.ObjectIdWriter objectIdWriter)
```

```java
public XmlBeanSerializer(XmlBeanSerializerBase src,
                         Set<String> toIgnore,
                         Set<String> toInclude)
```

```java
protected XmlBeanSerializer(XmlBeanSerializerBase src,
                            com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] properties,
                            com.fasterxml.jackson.databind.ser.BeanPropertyWriter[] filteredProperties)
```
Tokens:
Raw