Package org.apache.juneau.xml

Class XmlSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.xml.XmlSerializer

All Implemented Interfaces:

XmlMetaProvider

Direct Known Subclasses:

HtmlSerializer, SoapXmlSerializer, XmlDocSerializer, XmlSerializer.Ns, XmlSerializer.NsSq, XmlSerializer.NsSqReadable, XmlSerializer.Sq, XmlSerializer.SqReadable

public class XmlSerializer
extends WriterSerializer
implements XmlMetaProvider

Serializes POJO models to XML.

Media types

Handles Accept types: text/xml

Produces Content-Type types: text/xml

Description

See the JsonSerializer class for details on how Java models map to JSON.

For example, the following JSON...

{ name:'John Smith', address: { streetAddress: '21 2nd Street', city: 'New York', state: 'NY', postalCode: 10021 }, phoneNumbers: [ '212 555-1111', '212 555-2222' ], additionalInfo: null, remote: false, height: 62.4, 'fico score': ' > 640' }

...maps to the following XML using the default serializer...

<object> <name>John Smith</name> <address> <streetAddress>21 2nd Street</streetAddress> <city>New York</city> <state>NY</state> <postalCode>10021</postalCode> </address> <phoneNumbers> <string>212 555-1111</string> <string>212 555-2222</string> </phoneNumbers> <additionalInfo _type='null'></additionalInfo> <remote>false</remote> <height>62.4</height> <fico_x0020_score> &gt; 640</fico_x0020_score> </object>

An additional "add-json-properties" mode is also provided to prevent loss of JSON data types...

<object> <name _type='string'>John Smith</name> <address _type='object'> <streetAddress _type='string'>21 2nd Street</streetAddress> <city _type='string'>New York</city> <state _type='string'>NY</state> <postalCode _type='number'>10021</postalCode> </address> <phoneNumbers _type='array'> <string>212 555-1111</string> <string>212 555-2222</string> </phoneNumbers> <additionalInfo _type='null'></additionalInfo> <remote _type='boolean'>false</remote> <height _type='number'>62.4</height> <fico_x0020_score _type='string'> &gt; 640</fico_x0020_score> </object>

This serializer provides several serialization options. Typically, one of the predefined DEFAULT serializers will be sufficient. However, custom serializers can be constructed to fine-tune behavior.

If an attribute name contains any non-valid XML element characters, they will be escaped using standard _x####_ notation.

Behavior-specific subclasses

The following direct subclasses are provided for convenience:

• XmlSerializer.Sq - Default serializer, single quotes.
• XmlSerializer.SqReadable - Default serializer, single quotes, whitespace added.

Notes:

• This class is thread safe and reusable.

See Also:

• XML Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlSerializer.Builder	Builder class.
static class	XmlSerializer.Ns	Default serializer without namespaces.
static class	XmlSerializer.NsSq	Default serializer without namespaces, single quotes.
static class	XmlSerializer.NsSqReadable	Default serializer without namespaces, single quotes, with whitespace.
static class	XmlSerializer.Sq	Default serializer, single quotes.
static class	XmlSerializer.SqReadable	Default serializer, single quotes, whitespace added.

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	addBeanTypesXml
protected final boolean	addJsonTags
protected final boolean	addNamespaceUrlsToRoot
protected final boolean	autoDetectNamespaces
static final XmlSerializer	DEFAULT	Default serializer without namespaces.
protected static final Namespace	DEFAULT_JUNEAU_NAMESPACE
static final XmlSerializer	DEFAULT_NS	Default serializer, all default settings.
static final XmlSerializer	DEFAULT_NS_SQ	Default serializer, single quotes.
static final XmlSerializer	DEFAULT_NS_SQ_READABLE	Default serializer, single quotes, whitespace added.
static final XmlSerializer	DEFAULT_SQ	Default serializer without namespaces, with single quotes.
static final XmlSerializer	DEFAULT_SQ_READABLE	Default serializer without namespaces, with single quotes, whitespace added.
protected static final Namespace	DEFAULT_XS_NAMESPACE
protected final boolean	enableNamespaces

Fields inherited from class org.apache.juneau.serializer.WriterSerializer

maxIndent, quoteChar, quoteCharOverride, useWhitespace

Fields inherited from class org.apache.juneau.serializer.Serializer

accept, addRootType, keepNullProperties, listener, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.BeanContextable

beanContext

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
XmlSerializer(XmlSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
XmlSerializer.Builder	copy()	Creates a builder from this context object.
static XmlSerializer.Builder	create()	Creates a new builder for this object.
XmlSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final Namespace	getDefaultNamespace()	Default namespace.
protected final List<Namespace>	getNamespaces()	Default namespaces.
XmlSerializerSession	getSession()	Returns a session to use for this context.
protected final String	getTextNodeDelimiter()	Text node delimiter.
XmlBeanMeta	getXmlBeanMeta(BeanMeta<?> bm)	Returns the language-specific metadata on the specified bean.
XmlBeanPropertyMeta	getXmlBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
XmlClassMeta	getXmlClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
protected boolean	isAddBeanTypes()	Add "_type" properties when needed.
protected final boolean	isAddNamespaceUrlsToRoot()	Add namespace URLs to the root element.
protected final boolean	isAutoDetectNamespaces()	Auto-detect namespace usage.
protected final boolean	isEnableNamespaces()	Enable support for XML namespaces.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.

Methods inherited from class org.apache.juneau.serializer.WriterSerializer

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, serialize, toString

Methods inherited from class org.apache.juneau.serializer.Serializer

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT

public static final XmlSerializer DEFAULT

Default serializer without namespaces.

DEFAULT_SQ

public static final XmlSerializer DEFAULT_SQ

Default serializer without namespaces, with single quotes.

DEFAULT_SQ_READABLE

public static final XmlSerializer DEFAULT_SQ_READABLE

Default serializer without namespaces, with single quotes, whitespace added.

DEFAULT_NS

public static final XmlSerializer DEFAULT_NS

Default serializer, all default settings.

DEFAULT_NS_SQ

public static final XmlSerializer DEFAULT_NS_SQ

Default serializer, single quotes.

DEFAULT_NS_SQ_READABLE

public static final XmlSerializer DEFAULT_NS_SQ_READABLE

Default serializer, single quotes, whitespace added.

DEFAULT_JUNEAU_NAMESPACE

protected static final Namespace DEFAULT_JUNEAU_NAMESPACE

DEFAULT_XS_NAMESPACE

protected static final Namespace DEFAULT_XS_NAMESPACE

addBeanTypesXml

protected final boolean addBeanTypesXml

addJsonTags

protected final boolean addJsonTags

addNamespaceUrlsToRoot

protected final boolean addNamespaceUrlsToRoot

autoDetectNamespaces

protected final boolean autoDetectNamespaces

enableNamespaces

protected final boolean enableNamespaces

Constructor Details

XmlSerializer

public XmlSerializer(XmlSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static XmlSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public XmlSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class WriterSerializer

Returns:

A new Builder object.

createSession

public XmlSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class WriterSerializer

Returns:

A new session builder.

getSession

public XmlSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class WriterSerializer

Returns:

A new session object.

getXmlBeanMeta

public XmlBeanMeta getXmlBeanMeta(BeanMeta<?> bm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified bean.

Specified by:

getXmlBeanMeta in interface XmlMetaProvider

Parameters:

bm - The bean to return the metadata on.

Returns:

The metadata.

getXmlBeanPropertyMeta

public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getXmlBeanPropertyMeta in interface XmlMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getXmlClassMeta

public XmlClassMeta getXmlClassMeta(ClassMeta<?> cm)

Description copied from interface: XmlMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getXmlClassMeta in interface XmlMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getDefaultNamespace

protected final Namespace getDefaultNamespace()

Default namespace.

Returns:

The default namespace URI for this document.

See Also:

• XmlSerializer.Builder.defaultNamespace(Namespace)

getNamespaces

protected final List<Namespace> getNamespaces()

Default namespaces.

Returns:

The default list of namespaces associated with this serializer.
Never null.
List is unmodifiable.

See Also:

• XmlSerializer.Builder.namespaces(Namespace...)

getTextNodeDelimiter

protected final String getTextNodeDelimiter()

Text node delimiter.

Returns:

The delimiter string to insert between consecutive text nodes.
Never null.

See Also:

• XmlSerializer.Builder.textNodeDelimiter(String)

isAddBeanTypes

protected boolean isAddBeanTypes()

Add "_type" properties when needed.

Overrides:

isAddBeanTypes in class Serializer

Returns:

true if"_type" properties will be added to beans if their type cannot be inferred through reflection.

See Also:

• XmlSerializer.Builder.addBeanTypesXml()

isAddNamespaceUrlsToRoot

protected final boolean isAddNamespaceUrlsToRoot()

Add namespace URLs to the root element.

Returns:

true if xmlns:x attributes are added to the root element for the default and all mapped namespaces.

See Also:

• XmlSerializer.Builder.addNamespaceUrisToRoot()

isAutoDetectNamespaces

protected final boolean isAutoDetectNamespaces()

Auto-detect namespace usage.

Returns:

true if namespace usage is detected before serialization.

See Also:

• XmlSerializer.Builder.disableAutoDetectNamespaces()

isEnableNamespaces

protected final boolean isEnableNamespaces()

Enable support for XML namespaces.

Returns:

false if XML output will not contain any namespaces regardless of any other settings.

See Also:

• XmlSerializer.Builder.enableNamespaces()

properties

protected FluentMap<String,Object> properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class WriterSerializer

Returns:

The properties on this bean as a map for debugging.