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:
com.fasterxml.jackson.core.Versioned
,Serializable
public class XmlMapper
extends com.fasterxml.jackson.databind.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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Builder implementation for constructingXmlMapper
instances.Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.ObjectMapper
com.fasterxml.jackson.databind.ObjectMapper.DefaultTypeResolverBuilder, com.fasterxml.jackson.databind.ObjectMapper.DefaultTyping
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final JacksonXmlModule
protected static final JacksonXmlModule
protected static final DefaultXmlPrettyPrinter
private static final long
Fields inherited from class com.fasterxml.jackson.databind.ObjectMapper
_coercionConfigs, _configOverrides, _deserializationConfig, _deserializationContext, _injectableValues, _jsonFactory, _mixIns, _registeredModuleTypes, _rootDeserializers, _serializationConfig, _serializerFactory, _serializerProvider, _subtypeResolver, _typeFactory, DEFAULT_ANNOTATION_INTROSPECTOR, DEFAULT_BASE
-
Constructor Summary
ConstructorsModifierConstructorDescriptionXmlMapper
(JacksonXmlModule module) XmlMapper
(XmlFactory xmlFactory) XmlMapper
(XmlFactory xmlFactory, JacksonXmlModule module) protected
XmlMapper
(XMLInputFactory inputF) XmlMapper
(XMLInputFactory inputF, XMLOutputFactory outF) -
Method Summary
Modifier and TypeMethodDescriptionprotected com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder
<?> _constructDefaultTypeResolverBuilder
(com.fasterxml.jackson.databind.ObjectMapper.DefaultTyping applicability, com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator ptv) static XmlMapper.Builder
builder()
static XmlMapper.Builder
builder
(XmlFactory streamFactory) com.fasterxml.jackson.databind.ObjectMapper
configure
(FromXmlParser.Feature f, boolean state) com.fasterxml.jackson.databind.ObjectMapper
configure
(ToXmlGenerator.Feature f, boolean state) copy()
com.fasterxml.jackson.databind.ObjectMapper
com.fasterxml.jackson.databind.ObjectMapper
com.fasterxml.jackson.databind.ObjectMapper
com.fasterxml.jackson.databind.ObjectMapper
<T> T
readValue
(XMLStreamReader r, com.fasterxml.jackson.core.type.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 StaxXMLStreamReader
with data-binding by Jackson.<T> T
readValue
(XMLStreamReader r, com.fasterxml.jackson.databind.JavaType valueType) Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic StaxXMLStreamReader
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 StaxXMLStreamReader
with data-binding by Jackson.setDefaultUseWrapper
(boolean state) Deprecated.void
setXmlNameProcessor
(XmlNameProcessor processor) protected void
setXMLTextElementName
(String name) Deprecated.Since 2.10 useXmlMapper.Builder.nameForTextElement(String)
insteadcom.fasterxml.jackson.core.Version
version()
void
writeValue
(XMLStreamWriter w0, Object value) Method for serializing given value using specificXMLStreamReader
: useful when building large XML files by binding individual items, one at a time.static XmlMapper.Builder
Methods inherited from class com.fasterxml.jackson.databind.ObjectMapper
_assertNotNull, _checkInvalidCopy, _configAndWriteValue, _convert, _findRootDeserializer, _initForReading, _newReader, _newReader, _newWriter, _newWriter, _newWriter, _readMapAndClose, _readTreeAndClose, _readValue, _serializerProvider, _verifyNoTrailingTokens, _verifySchemaType, _writeValueAndClose, 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, createDeserializationContext, createGenerator, createGenerator, createGenerator, createGenerator, createGenerator, createNonBlockingByteArrayParser, createObjectNode, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, createParser, deactivateDefaultTyping, defaultClassIntrospector, 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
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
DEFAULT_XML_MODULE
-
DEFAULT_XML_PRETTY_PRINTER
-
_xmlModule
-
-
Constructor Details
-
XmlMapper
public XmlMapper() -
XmlMapper
- Since:
- 2.4
-
XmlMapper
- Since:
- 2.4
-
XmlMapper
-
XmlMapper
-
XmlMapper
-
XmlMapper
- Since:
- 2.8.9
-
-
Method Details
-
copy
- Overrides:
copy
in classcom.fasterxml.jackson.databind.ObjectMapper
-
xmlBuilder
- Since:
- 2.10
-
builder
- Since:
- 2.10
-
builder
- Since:
- 2.10
-
version
public com.fasterxml.jackson.core.Version version()- Specified by:
version
in interfacecom.fasterxml.jackson.core.Versioned
- Overrides:
version
in classcom.fasterxml.jackson.databind.ObjectMapper
-
_constructDefaultTypeResolverBuilder
protected com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder<?> _constructDefaultTypeResolverBuilder(com.fasterxml.jackson.databind.ObjectMapper.DefaultTyping applicability, com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator ptv) - Overrides:
_constructDefaultTypeResolverBuilder
in classcom.fasterxml.jackson.databind.ObjectMapper
-
setXMLTextElementName
Deprecated.Since 2.10 useXmlMapper.Builder.nameForTextElement(String)
insteadMethod called byJacksonXmlModule
to pass configuration information toXmlFactory
, during registration; NOT exposed as public method since configuration should be done viaJacksonXmlModule
.- Since:
- 2.1
-
setDefaultUseWrapper
Deprecated.Since 2.10 useXmlMapper.Builder.defaultUseWrapper(boolean)
insteadSince 2.7 -
setXmlNameProcessor
- Since:
- 2.14
-
getFactory
- Overrides:
getFactory
in classcom.fasterxml.jackson.databind.ObjectMapper
-
configure
public com.fasterxml.jackson.databind.ObjectMapper configure(ToXmlGenerator.Feature f, boolean state) -
configure
public com.fasterxml.jackson.databind.ObjectMapper configure(FromXmlParser.Feature f, boolean state) -
enable
-
enable
-
disable
-
disable
-
readValue
Method for reading a single XML value from given XML-specific input source; useful for incremental data-binding, combining traversal using basic StaxXMLStreamReader
with data-binding by Jackson.- Throws:
IOException
- Since:
- 2.4
-
readValue
public <T> T readValue(XMLStreamReader r, com.fasterxml.jackson.core.type.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 StaxXMLStreamReader
with data-binding by Jackson.- Throws:
IOException
- Since:
- 2.4
-
readValue
public <T> T readValue(XMLStreamReader r, com.fasterxml.jackson.databind.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 StaxXMLStreamReader
with data-binding by Jackson.- Throws:
IOException
- Since:
- 2.4
-
writeValue
Method for serializing given value using specificXMLStreamReader
: useful when building large XML files by binding individual items, one at a time.- Throws:
IOException
- Since:
- 2.4
-
XmlMapper.Builder.defaultUseWrapper(boolean)
instead