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

public Class XmlMapper

extends ObjectMapper
Class Inheritance
Imports
java.io.IOException, javax.xml.stream.XMLInputFactory, .XMLOutputFactory, .XMLStreamReader, .XMLStreamWriter, com.fasterxml.jackson.core.*, com.fasterxml.jackson.core.type.TypeReference, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.cfg.CoercionAction, .CoercionInputShape, .MapperBuilder, com.fasterxml.jackson.databind.deser.BeanDeserializerFactory, com.fasterxml.jackson.databind.jsontype.PolymorphicTypeValidator, .TypeResolverBuilder, com.fasterxml.jackson.databind.ser.SerializerFactory, com.fasterxml.jackson.databind.type.LogicalType, com.fasterxml.jackson.dataformat.xml.deser.FromXmlParser, .XmlDeserializationContext, com.fasterxml.jackson.dataformat.xml.ser.ToXmlGenerator, .XmlSerializerProvider, com.fasterxml.jackson.dataformat.xml.util.DefaultXmlPrettyPrinter, .XmlRootNameLookup
Customized ObjectMapper that will read and write XML instead of JSON, using XML-backed com.fasterxml.jackson.core.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.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XmlMapper.Builder

Builder implementation for constructing XmlMapper instances.

Field Summary

Modifier and TypeField and Description
protected final JacksonXmlModule
_xmlModule

protected static final JacksonXmlModule
DEFAULT_XML_MODULE

protected static final DefaultXmlPrettyPrinter
DEFAULT_XML_PRETTY_PRINTER

private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.ObjectMapper.serialVersionUID.

Inherited from com.fasterxml.jackson.databind.ObjectMapper:
_coercionConfigs_configOverrides_deserializationConfig_deserializationContext_injectableValues_jsonFactory_mixIns_registeredModuleTypes_rootDeserializers_serializationConfig_serializerFactory_serializerProvider_subtypeResolver_typeFactoryDEFAULT_ANNOTATION_INTROSPECTORDEFAULT_BASE

Constructor Summary

AccessConstructor and Description
public
XmlMapper()

public
XmlMapper(XMLInputFactory inputF, XMLOutputFactory outF)

public
XmlMapper(XMLInputFactory inputF)

public
XmlMapper(XmlFactory xmlFactory)

public
XmlMapper(JacksonXmlModule module)

public
XmlMapper(XmlFactory xmlFactory, JacksonXmlModule module)

protected
XmlMapper(XmlMapper src)

Method Summary

Modifier and TypeMethod and Description
protected TypeResolverBuilder<?>
_constructDefaultTypeResolverBuilder(ObjectMapper.DefaultTyping applicability, PolymorphicTypeValidator ptv)

Overrides com.fasterxml.jackson.databind.ObjectMapper._constructDefaultTypeResolverBuilder.

Overridable factory method, separate to allow format-specific mappers (and specifically XML-backed one, currently) to offer custom TypeResolverBuilder subtypes.

public static XmlMapper.Builder
builder()

public static XmlMapper.Builder
builder(XmlFactory streamFactory)

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

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

public XmlMapper
copy()

Overrides com.fasterxml.jackson.databind.ObjectMapper.copy.

Method for creating a new ObjectMapper instance that has same initial configuration as this instance.

public ToXmlGenerator
createGenerator(XMLStreamWriter w)

Overloaded variant that allows constructing ToXmlGenerator for given Stax XMLStreamWriter.

public FromXmlParser
createParser(XMLStreamReader r)

Overloaded variant that allows constructing FromXmlParser for given Stax XMLStreamReader.

public ObjectMapper
disable(ToXmlGenerator.Feature f)

public ObjectMapper
disable(FromXmlParser.Feature f)

public ObjectMapper
enable(ToXmlGenerator.Feature f)

public ObjectMapper
enable(FromXmlParser.Feature f)

public XmlFactory
getFactory()

Overrides com.fasterxml.jackson.databind.ObjectMapper.getFactory.

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

public <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.

public <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.

public <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.

public XmlMapper
setDefaultUseWrapper(boolean state)
Deprecated Since 2.10 use Builder#defaultUseWrapper(boolean) instead

Since 2.7

public void
setXmlNameProcessor(XmlNameProcessor processor)

protected void
setXMLTextElementName(String name)
Deprecated Since 2.10 use Builder#nameForTextElement(String) instead

Method called by JacksonXmlModule to pass configuration information to XmlFactory, during registration; NOT exposed as public method since configuration should be done via JacksonXmlModule.

public Version
version()

Overrides com.fasterxml.jackson.databind.ObjectMapper.version.

Implements com.fasterxml.jackson.core.Versioned.version.

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

public 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.

public static XmlMapper.Builder
xmlBuilder()

Inherited from com.fasterxml.jackson.databind.ObjectMapper:
_assertNotNull_checkInvalidCopy_configAndWriteValue_convert_findRootDeserializer_initForReading_newReader_newReader_newWriter_newWriter_newWriter_readMapAndClose_readTreeAndClose_readValue_serializerProvider_verifyNoTrailingTokens_verifySchemaType_writeValueAndCloseacceptJsonFormatVisitoracceptJsonFormatVisitoractivateDefaultTypingactivateDefaultTypingactivateDefaultTypingactivateDefaultTypingAsPropertyaddHandleraddMixInaddMixInAnnotationscanDeserializecanDeserializecanSerializecanSerializeclearProblemHandlerscoercionConfigDefaultscoercionConfigForcoercionConfigForconfigOverrideconfigureconfigureconfigureconfigureconfigureconfigureconstructTypeconstructTypeconvertValueconvertValueconvertValuecopyWithcreateArrayNodecreateDeserializationContextcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateGeneratorcreateNonBlockingByteArrayParsercreateObjectNodecreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParsercreateParserdeactivateDefaultTypingdefaultClassIntrospectordisabledisabledisabledisabledisabledisabledisabledisableDefaultTypingenableenableenableenableenableenableenableenableDefaultTypingenableDefaultTypingenableDefaultTypingenableDefaultTypingAsPropertyfindAndRegisterModulesfindMixInClassForfindModulesfindModulesgenerateJsonSchemagetDateFormatgetDeserializationConfiggetDeserializationContextgetInjectableValuesgetNodeFactorygetPolymorphicTypeValidatorgetPropertyNamingStrategygetRegisteredModuleIdsgetSerializationConfiggetSerializerFactorygetSerializerProvidergetSerializerProviderInstancegetSubtypeResolvergetTypeFactorygetVisibilityCheckerisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledisEnabledmissingNodemixInCountnullNodereaderreaderreaderreaderreaderreaderreaderreaderreaderreaderreaderreaderForreaderForreaderForreaderForArrayOfreaderForListOfreaderForMapOfreaderForUpdatingreaderWithViewreadTreereadTreereadTreereadTreereadTreereadTreereadTreereadTreereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuereadValuesreadValuesreadValuesreadValuesregisterModuleregisterModulesregisterModulesregisterSubtypesregisterSubtypesregisterSubtypessetAccessorNamingsetAnnotationIntrospectorsetAnnotationIntrospectorssetBase64VariantsetCacheProvidersetConfigsetConfigsetConstructorDetectorsetDateFormatsetDefaultAttributessetDefaultLeniencysetDefaultMergeablesetDefaultPrettyPrintersetDefaultPropertyInclusionsetDefaultPropertyInclusionsetDefaultSetterInfosetDefaultTypingsetDefaultVisibilitysetFilterProvidersetFilterssetHandlerInstantiatorsetInjectableValuessetLocalesetMixInAnnotationssetMixInResolversetMixInssetNodeFactorysetPolymorphicTypeValidatorsetPropertyInclusionsetPropertyNamingStrategysetSerializationInclusionsetSerializerFactorysetSerializerProvidersetSubtypeResolversetTimeZonesetTypeFactorysetVisibilitysetVisibilitysetVisibilityCheckertokenStreamFactorytreeAsTokenstreeToValuetreeToValuetreeToValueupdateValuevalueToTreewriterwriterwriterwriterwriterwriterwriterwriterwriterwriterwriterForwriterForwriterForwriterWithDefaultPrettyPrinterwriterWithTypewriterWithTypewriterWithTypewriterWithViewwriteTreewriteTreewriteValuewriteValuewriteValuewriteValuewriteValuewriteValueAsByteswriteValueAsString