Package org.apache.juneau.marshall.xml

Class XmlSerializerSession.Builder<SELF extends XmlSerializerSession.Builder<SELF>>

java.lang.Object

org.apache.juneau.marshall.ContextSession.Builder<SELF>

org.apache.juneau.marshall.MarshallingSession.Builder<SELF>

org.apache.juneau.marshall.MarshallingTraverseSession.Builder<SELF>

org.apache.juneau.marshall.serializer.SerializerSession.Builder<SELF>

org.apache.juneau.marshall.serializer.WriterSerializerSession.Builder<SELF>

org.apache.juneau.marshall.xml.XmlSerializerSession.Builder<SELF>

Direct Known Subclasses:

HtmlSerializerSession.Builder, SoapXmlSerializerSession.Builder, XmlDocSerializerSession.Builder, XmlSerializerSession.DefaultBuilder

Enclosing class:

XmlSerializerSession

public abstract static class XmlSerializerSession.Builder<SELF extends XmlSerializerSession.Builder<SELF>>
extends WriterSerializerSession.Builder<SELF>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(XmlSerializer ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
SELF	addNamespaceUrisToRoot(boolean value)	Add namespace URLs to the root element.
SELF	autoDetectNamespaces(boolean value)	Auto-detect namespace usage.
XmlSerializerSession	build()	Build the object.
SELF	defaultNamespace(String value)	Default namespace.
SELF	enableNamespaces(boolean value)	Enable support for XML namespaces.
SELF	property(String key, Object value)	Adds a property to this session.
SELF	textNodeDelimiter(String value)	Text node delimiter.

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializerSession.Builder

maxIndent, quoteChar, streamCharset, useWhitespace

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerSession.Builder

addBeanTypes, addRootType, javaMethod, keepNullProperties, nonDefault, resolver, schema, schemaDefault, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings, uriContext

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession.Builder

initialDepth

Methods inherited from class org.apache.juneau.marshall.MarshallingSession.Builder

activeView, locale, mediaType, mediaTypeDefault, timeZone, timeZoneDefault

Methods inherited from class org.apache.juneau.marshall.ContextSession.Builder

apply, cvt, debug, properties, self, unmodifiable

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(XmlSerializer ctx)

Constructor

Parameters:

ctx - The context creating this session.
Cannot be null.

Method Details

build

public XmlSerializerSession build()

Description copied from class: MarshallingSession.Builder

Build the object.

Overrides:

build in class WriterSerializerSession.Builder<SELF extends XmlSerializerSession.Builder<SELF>>

Returns:

The built object.

addNamespaceUrisToRoot

public SELF addNamespaceUrisToRoot(boolean value)

Add namespace URLs to the root element.

Parameters:

value - The new value for this setting.

Returns:

This object.

autoDetectNamespaces

public SELF autoDetectNamespaces(boolean value)

Auto-detect namespace usage.

Parameters:

value - The new value for this setting.

Returns:

This object.

defaultNamespace

public SELF defaultNamespace(String value)

Default namespace.

Parameters:

value - The new value for this setting.

Returns:

This object.

enableNamespaces

public SELF enableNamespaces(boolean value)

Enable support for XML namespaces.

Parameters:

value - The new value for this setting.

Returns:

This object.

textNodeDelimiter

public SELF textNodeDelimiter(String value)

Text node delimiter.

Parameters:

value - The new value for this setting.

Returns:

This object.

property

public SELF property(String key,
 Object value)

Description copied from class: ContextSession.Builder

Adds a property to this session.

If the key matches a known session property (e.g. "debug" or "ContextSession.debug"), the value is converted via BasicConverter and routed to the corresponding typed setter. Unknown keys are stored in the raw session properties map.

Overrides:

property in class WriterSerializerSession.Builder<SELF extends XmlSerializerSession.Builder<SELF>>

Parameters:

key - The property key.
Cannot be null.

value - The property value.
Can be null (resets typed properties to their default; removes raw properties).

Returns:

This object.