Package com.fasterxml.jackson.dataformat.xml

Class XmlMapper

java.lang.Object

com.fasterxml.jackson.core.TreeCodec

com.fasterxml.jackson.core.ObjectCodec

com.fasterxml.jackson.databind.ObjectMapper

com.fasterxml.jackson.dataformat.xml.XmlMapper

All Implemented Interfaces:

Versioned, Serializable

public class XmlMapper
extends ObjectMapper

Customized ObjectMapper that will read and write XML instead of JSON, using XML-backed JsonFactory implementation (XmlFactory).

Mapper itself overrides some aspects of functionality to try to handle data binding aspects as similar to JAXB as possible.

Note that most of configuration should be done by pre-constructing JacksonXmlModule explicitly, instead of relying on default settings.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlMapper.Builder	Builder implementation for constructing XmlMapper instances.

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.ObjectMapper

ObjectMapper.DefaultTypeResolverBuilder, ObjectMapper.DefaultTyping

Constructor Summary

Constructors

Constructor	Description
XmlMapper()
XmlMapper(JacksonXmlModule module)
XmlMapper(XmlFactory xmlFactory)
XmlMapper(XmlFactory xmlFactory, JacksonXmlModule module)
XmlMapper(XMLInputFactory inputF)
XmlMapper(XMLInputFactory inputF, XMLOutputFactory outF)

Method Summary

Modifier and Type	Method	Description
static XmlMapper.Builder	builder()
static XmlMapper.Builder	builder(XmlFactory streamFactory)
ObjectMapper	configure(FromXmlParser.Feature f, boolean state)
ObjectMapper	configure(ToXmlGenerator.Feature f, boolean state)
XmlMapper	copy()	Method for creating a new ObjectMapper instance that has same initial configuration as this instance.
ToXmlGenerator	createGenerator(XMLStreamWriter w)	Overloaded variant that allows constructing ToXmlGenerator for given Stax XMLStreamWriter.
FromXmlParser	createParser(XMLStreamReader r)	Overloaded variant that allows constructing FromXmlParser for given Stax XMLStreamReader.
ObjectMapper	disable(FromXmlParser.Feature f)
ObjectMapper	disable(ToXmlGenerator.Feature f)
ObjectMapper	enable(FromXmlParser.Feature f)
ObjectMapper	enable(ToXmlGenerator.Feature f)
XmlFactory	getFactory()	Accessor for finding underlying data format factory (JsonFactory) codec will use for data binding.
<T> T	readValue(XMLStreamReader r, TypeReference<T> valueTypeRef)	Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic Stax XMLStreamReader with data-binding by Jackson.
<T> T	readValue(XMLStreamReader r, JavaType valueType)	Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic Stax XMLStreamReader with data-binding by Jackson.
<T> T	readValue(XMLStreamReader r, Class<T> valueType)	Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic Stax XMLStreamReader with data-binding by Jackson.
XmlMapper	setDefaultUseWrapper(boolean state)	Deprecated. Since 2.10 use XmlMapper.Builder.defaultUseWrapper(boolean) instead
void	setXmlNameProcessor(XmlNameProcessor processor)
Version	version()	Method that will return version information stored in and read from jar that contains this class.
void	writeValue(XMLStreamWriter w, Object value)	Method for serializing given value using specific XMLStreamReader: useful when building large XML files by binding individual items, one at a time.
static XmlMapper.Builder	xmlBuilder()

Methods inherited from class com.fasterxml.jackson.databind.ObjectMapper

acceptJsonFormatVisitor, acceptJsonFormatVisitor, activateDefaultTyping, activateDefaultTyping, activateDefaultTyping, activateDefaultTypingAsProperty, addHandler, addMixIn, addMixInAnnotations, canDeserialize, canDeserialize, canSerialize, canSerialize, clearProblemHandlers, coercionConfigDefaults, coercionConfigFor, coercionConfigFor, configOverride, configure, configure, configure, configure, configure, configure, constructType, constructType, convertValue, convertValue, convertValue, copyWith, createArrayNode, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createNonBlockingByteArrayParser, createObjectNode, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, deactivateDefaultTyping, disable, disable, disable, disable, disable, disable, disable, disableDefaultTyping, enable, enable, enable, enable, enable, enable, enable, enableDefaultTyping, enableDefaultTyping, enableDefaultTyping, enableDefaultTypingAsProperty, findAndRegisterModules, findMixInClassFor, findModules, findModules, generateJsonSchema, getDateFormat, getDeserializationConfig, getDeserializationContext, getInjectableValues, getNodeFactory, getPolymorphicTypeValidator, getPropertyNamingStrategy, getRegisteredModuleIds, getSerializationConfig, getSerializerFactory, getSerializerProvider, getSerializerProviderInstance, getSubtypeResolver, getTypeFactory, getVisibilityChecker, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, isEnabled, missingNode, mixInCount, nullNode, reader, reader, reader, reader, reader, reader, reader, reader, reader, reader, reader, readerFor, readerFor, readerFor, readerForArrayOf, readerForListOf, readerForMapOf, readerForUpdating, readerWithView, readTree, readTree, readTree, readTree, readTree, readTree, readTree, readTree, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValue, readValues, readValues, readValues, readValues, registerModule, registerModules, registerModules, registerSubtypes, registerSubtypes, registerSubtypes, setAccessorNaming, setAnnotationIntrospector, setAnnotationIntrospectors, setBase64Variant, setCacheProvider, setConfig, setConfig, setConstructorDetector, setDateFormat, setDefaultAttributes, setDefaultLeniency, setDefaultMergeable, setDefaultPrettyPrinter, setDefaultPropertyInclusion, setDefaultPropertyInclusion, setDefaultSetterInfo, setDefaultTyping, setDefaultVisibility, setFilterProvider, setFilters, setHandlerInstantiator, setInjectableValues, setLocale, setMixInAnnotations, setMixInResolver, setMixIns, setNodeFactory, setPolymorphicTypeValidator, setPropertyInclusion, setPropertyNamingStrategy, setSerializationInclusion, setSerializerFactory, setSerializerProvider, setSubtypeResolver, setTimeZone, setTypeFactory, setVisibility, setVisibility, setVisibilityChecker, tokenStreamFactory, treeAsTokens, treeToValue, treeToValue, treeToValue, updateValue, valueToTree, writer, writer, writer, writer, writer, writer, writer, writer, writer, writer, writerFor, writerFor, writerFor, writerWithDefaultPrettyPrinter, writerWithType, writerWithType, writerWithType, writerWithView, writeTree, writeTree, writeValue, writeValue, writeValue, writeValue, writeValue, writeValueAsBytes, writeValueAsString

Methods inherited from class com.fasterxml.jackson.core.ObjectCodec

getJsonFactory

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XmlMapper

public XmlMapper()

XmlMapper

public XmlMapper(XMLInputFactory inputF,
 XMLOutputFactory outF)

Since:

2.4

XmlMapper

public XmlMapper(XMLInputFactory inputF)

Since:

2.4

XmlMapper

public XmlMapper(XmlFactory xmlFactory)

XmlMapper

public XmlMapper(JacksonXmlModule module)

XmlMapper

public XmlMapper(XmlFactory xmlFactory,
 JacksonXmlModule module)

Method Details

copy

public XmlMapper copy()

Description copied from class: ObjectMapper

Method for creating a new ObjectMapper instance that has same initial configuration as this instance. Note that this also requires making a copy of the underlying JsonFactory instance.

Method is typically used when multiple, differently configured mappers are needed. Although configuration is shared, cached serializers and deserializers are NOT shared, which means that the new instance may be re-configured before use; meaning that it behaves the same way as if an instance was constructed from scratch.

Overrides:

copy in class ObjectMapper

xmlBuilder

public static XmlMapper.Builder xmlBuilder()

Since:

2.10

builder

public static XmlMapper.Builder builder()

Since:

2.10

builder

public static XmlMapper.Builder builder(XmlFactory streamFactory)

Since:

2.10

version

public Version version()

Description copied from class: ObjectMapper

Method that will return version information stored in and read from jar that contains this class.

Specified by:

version in interface Versioned

Overrides:

version in class ObjectMapper

Returns:

Version of the component

setDefaultUseWrapper

@Deprecated
public XmlMapper setDefaultUseWrapper(boolean state)

Deprecated.

Since 2.10 use XmlMapper.Builder.defaultUseWrapper(boolean) instead

Since 2.7

setXmlNameProcessor

public void setXmlNameProcessor(XmlNameProcessor processor)

Since:

2.14

getFactory

public XmlFactory getFactory()

Description copied from class: ObjectCodec

Accessor for finding underlying data format factory (JsonFactory) codec will use for data binding.

Overrides:

getFactory in class ObjectMapper

Returns:

Underlying JsonFactory instance

configure

public ObjectMapper configure(ToXmlGenerator.Feature f,
 boolean state)

configure

public ObjectMapper configure(FromXmlParser.Feature f,
 boolean state)

enable

public ObjectMapper enable(ToXmlGenerator.Feature f)

enable

public ObjectMapper enable(FromXmlParser.Feature f)

disable

public ObjectMapper disable(ToXmlGenerator.Feature f)

disable

public ObjectMapper disable(FromXmlParser.Feature f)

createParser

public FromXmlParser createParser(XMLStreamReader r)
                           throws IOException

Overloaded variant that allows constructing FromXmlParser for given Stax XMLStreamReader.

Throws:

IOException

Since:

2.17

createGenerator

public ToXmlGenerator createGenerator(XMLStreamWriter w)
                               throws IOException

Overloaded variant that allows constructing ToXmlGenerator for given Stax XMLStreamWriter.

Throws:

IOException

Since:

2.17

readValue

public <T> T readValue(XMLStreamReader r,
 Class<T> valueType)
                throws IOException

Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic Stax XMLStreamReader with data-binding by Jackson.

Throws:

IOException

Since:

2.4

readValue

public <T> T readValue(XMLStreamReader r,
 TypeReference<T> valueTypeRef)
                throws IOException

Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic Stax XMLStreamReader with data-binding by Jackson.

Throws:

IOException

Since:

2.4

readValue

public <T> T readValue(XMLStreamReader r,
 JavaType valueType)
                throws IOException

Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic Stax XMLStreamReader with data-binding by Jackson.

Throws:

IOException

Since:

2.4

writeValue

public void writeValue(XMLStreamWriter w,
 Object value)
                throws IOException

Method for serializing given value using specific XMLStreamReader: useful when building large XML files by binding individual items, one at a time.

Throws:

IOException

Since:

2.4