Package org.apache.juneau.xml

Class XmlParserSession.Builder

java.lang.Object

org.apache.juneau.ContextSession.Builder

org.apache.juneau.BeanSession.Builder

org.apache.juneau.parser.ParserSession.Builder

org.apache.juneau.parser.ReaderParserSession.Builder

org.apache.juneau.xml.XmlParserSession.Builder

Direct Known Subclasses:

HtmlParserSession.Builder

Enclosing class:

XmlParserSession

public static class XmlParserSession.Builder
extends ReaderParserSession.Builder

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(XmlParser ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
<T> XmlParserSession.Builder	apply(Class<T> type, Consumer<T> apply)	Applies a consumer to this builder if it's the specified type.
XmlParserSession	build()	Build the object.
XmlParserSession.Builder	debug(Boolean value)	Debug mode.
XmlParserSession.Builder	fileCharset(Charset value)	File charset.
XmlParserSession.Builder	javaMethod(Method value)	The java method that called this serializer, usually the method in a REST servlet.
XmlParserSession.Builder	locale(Locale value)	The session locale.
XmlParserSession.Builder	localeDefault(Locale value)	Same as BeanSession.Builder.locale(Locale) but doesn't overwrite the value if it is already set.
XmlParserSession.Builder	mediaType(MediaType value)	The session media type.
XmlParserSession.Builder	mediaTypeDefault(MediaType value)	Same as BeanSession.Builder.mediaType(MediaType) but doesn't overwrite the value if it is already set.
XmlParserSession.Builder	outer(Object value)	The outer object for instantiating top-level non-static inner classes.
XmlParserSession.Builder	properties(Map<String,Object> value)	Session properties.
XmlParserSession.Builder	property(String key, Object value)	Adds a property to this session.
XmlParserSession.Builder	schema(HttpPartSchema value)	HTTP-part schema.
XmlParserSession.Builder	schemaDefault(HttpPartSchema value)	Same as ParserSession.Builder.schema(HttpPartSchema) but doesn't overwrite the value if it is already set.
XmlParserSession.Builder	streamCharset(Charset value)	Input stream charset.
XmlParserSession.Builder	timeZone(TimeZone value)	The session timezone.
XmlParserSession.Builder	timeZoneDefault(TimeZone value)	Same as BeanSession.Builder.timeZone(TimeZone) but doesn't overwrite the value if it is already set.
XmlParserSession.Builder	unmodifiable()	Create an unmodifiable session.

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.

Method Details

build

public XmlParserSession build()

Description copied from class: BeanSession.Builder

Build the object.

Overrides:

build in class ReaderParserSession.Builder

Returns:

The built object.

apply

public <T> XmlParserSession.Builder apply(Class<T> type,
 Consumer<T> apply)

Description copied from class: ContextSession.Builder

Applies a consumer to this builder if it's the specified type.

Overrides:

apply in class ReaderParserSession.Builder

Type Parameters:

T - The expected type.

Parameters:

type - The expected type.

apply - The consumer to apply.

Returns:

This object.

debug

public XmlParserSession.Builder debug(Boolean value)

Description copied from class: ContextSession.Builder

Debug mode.

Enables the following additional information during parsing:

• When bean setters throws exceptions, the exception includes the object stack information in order to determine how that method was invoked.

If not specified, defaults to Context.Builder.debug().

See Also:

• BeanConfig.debug()
• Context.Builder.debug()

Overrides:

debug in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
Can be null. Value will be ignored.

Returns:

This object.

properties

public XmlParserSession.Builder properties(Map<String,Object> value)

Description copied from class: ContextSession.Builder

Session properties.

Session properties are generic key-value pairs that can be passed through the session and made available to any customized serializers/parsers or swaps.

Overrides:

properties in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
Can be null.

Returns:

This object.

property

public XmlParserSession.Builder property(String key,
 Object value)

Description copied from class: ContextSession.Builder

Adds a property to this session.

Overrides:

property in class ReaderParserSession.Builder

Parameters:

key - The property key.

value - The property value.

Returns:

This object.

unmodifiable

public XmlParserSession.Builder unmodifiable()

Description copied from class: ContextSession.Builder

Create an unmodifiable session.

The created ContextSession object will be unmodifiable which makes it suitable for caching and reuse.

Overrides:

unmodifiable in class ReaderParserSession.Builder

Returns:

This object.

locale

public XmlParserSession.Builder locale(Locale value)

Description copied from class: BeanSession.Builder

The session locale.

Specifies the default locale for serializer and parser sessions.

If not specified, defaults to BeanContext.Builder.locale(Locale).

See Also:

• BeanConfig.locale()
• BeanContext.Builder.locale(Locale)

Overrides:

locale in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
If null, then the locale defined on the context is used.

Returns:

This object.

localeDefault

public XmlParserSession.Builder localeDefault(Locale value)

Description copied from class: BeanSession.Builder

Same as BeanSession.Builder.locale(Locale) but doesn't overwrite the value if it is already set.

Overrides:

localeDefault in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
If null, then the locale defined on the context is used.

Returns:

This object.

mediaType

public XmlParserSession.Builder mediaType(MediaType value)

Description copied from class: BeanSession.Builder

The session media type.

Specifies the default media type value for serializer and parser sessions.

If not specified, defaults to BeanContext.Builder.mediaType(MediaType).

See Also:

• BeanConfig.mediaType()
• BeanContext.Builder.mediaType(MediaType)

Overrides:

mediaType in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
Can be null.

Returns:

This object.

mediaTypeDefault

public XmlParserSession.Builder mediaTypeDefault(MediaType value)

Description copied from class: BeanSession.Builder

Same as BeanSession.Builder.mediaType(MediaType) but doesn't overwrite the value if it is already set.

Overrides:

mediaTypeDefault in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
If null, then the locale defined on the context is used.

Returns:

This object.

timeZone

public XmlParserSession.Builder timeZone(TimeZone value)

Description copied from class: BeanSession.Builder

The session timezone.

Specifies the default timezone for serializer and parser sessions.

If not specified, defaults to BeanContext.Builder.timeZone(TimeZone).

See Also:

• BeanConfig.timeZone()
• BeanContext.Builder.timeZone(TimeZone)

Overrides:

timeZone in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
Can be null.

Returns:

This object.

timeZoneDefault

public XmlParserSession.Builder timeZoneDefault(TimeZone value)

Description copied from class: BeanSession.Builder

Same as BeanSession.Builder.timeZone(TimeZone) but doesn't overwrite the value if it is already set.

Overrides:

timeZoneDefault in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
If null, then the locale defined on the context is used.

Returns:

This object.

javaMethod

public XmlParserSession.Builder javaMethod(Method value)

Description copied from class: ParserSession.Builder

The java method that called this serializer, usually the method in a REST servlet.

Overrides:

javaMethod in class ReaderParserSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

outer

public XmlParserSession.Builder outer(Object value)

Description copied from class: ParserSession.Builder

The outer object for instantiating top-level non-static inner classes.

Overrides:

outer in class ReaderParserSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

schema

public XmlParserSession.Builder schema(HttpPartSchema value)

Description copied from class: ParserSession.Builder

HTTP-part schema.

Used for schema-based serializers and parsers to define additional formatting.

Overrides:

schema in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
Can be null.

Returns:

This object.

schemaDefault

public XmlParserSession.Builder schemaDefault(HttpPartSchema value)

Description copied from class: ParserSession.Builder

Same as ParserSession.Builder.schema(HttpPartSchema) but doesn't overwrite the value if it is already set.

Overrides:

schemaDefault in class ReaderParserSession.Builder

Parameters:

value - The new value for this property.
If null, then the locale defined on the context is used.

Returns:

This object.

fileCharset

public XmlParserSession.Builder fileCharset(Charset value)

Description copied from class: ReaderParserSession.Builder

File charset.

The character set to use for reading Files from the file system.

Used when passing in files to Parser.parse(Object, Class).

If not specified, defaults to the JVM system default charset.

Overrides:

fileCharset in class ReaderParserSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

streamCharset

public XmlParserSession.Builder streamCharset(Charset value)

Description copied from class: ReaderParserSession.Builder

Input stream charset.

The character set to use for converting InputStreams and byte arrays to readers.

Used when passing in input streams and byte arrays to Parser.parse(Object, Class).

If not specified, defaults to UTF-8.

Overrides:

streamCharset in class ReaderParserSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.