Package org.apache.juneau.marshall.xml

Class XmlParserSession.Builder<SELF extends XmlParserSession.Builder<SELF>>

java.lang.Object

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

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

org.apache.juneau.marshall.parser.ParserSession.Builder<SELF>

org.apache.juneau.marshall.parser.ReaderParserSession.Builder<SELF>

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

Direct Known Subclasses:

HtmlParserSession.Builder, XmlParserSession.DefaultBuilder

Enclosing class:

XmlParserSession

public abstract static class XmlParserSession.Builder<SELF extends XmlParserSession.Builder<SELF>>
extends ReaderParserSession.Builder<SELF>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(XmlParser ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
XmlParserSession	build()	Build the object.
SELF	preserveRootElement(boolean value)	Preserve root element during XML parsing.
SELF	property(String key, Object value)	Adds a property to this session.
SELF	validating(boolean value)	Validate XML during parsing.

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParserSession.Builder

streamCharset

Methods inherited from class org.apache.juneau.marshall.parser.ParserSession.Builder

javaMethod, maxParseDepth, nulls, outer, schema, schemaDefault, trimStrings

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(XmlParser ctx)

Constructor

Parameters:

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

Method Details

build

public XmlParserSession build()

Description copied from class: MarshallingSession.Builder

Build the object.

Overrides:

build in class ReaderParserSession.Builder<SELF extends XmlParserSession.Builder<SELF>>

Returns:

The built object.

preserveRootElement

public SELF preserveRootElement(boolean value)

Preserve root element during XML parsing.

Parameters:

value - The new value for this setting.

Returns:

This object.

validating

public SELF validating(boolean value)

Validate XML during parsing.

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 ReaderParserSession.Builder<SELF extends XmlParserSession.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.