Package org.apache.juneau.xml

Class XmlSerializerSession.Builder

java.lang.Object

org.apache.juneau.ContextSession.Builder

org.apache.juneau.BeanSession.Builder

org.apache.juneau.BeanTraverseSession.Builder

org.apache.juneau.serializer.SerializerSession.Builder

org.apache.juneau.serializer.WriterSerializerSession.Builder

org.apache.juneau.xml.XmlSerializerSession.Builder

Direct Known Subclasses:

HtmlSerializerSession.Builder, SoapXmlSerializerSession.Builder, XmlDocSerializerSession.Builder

Enclosing class:

XmlSerializerSession

public static class XmlSerializerSession.Builder
extends WriterSerializerSession.Builder

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(XmlSerializer ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
<T> XmlSerializerSession.Builder	apply(Class<T> type, Consumer<T> apply)	Applies a consumer to this builder if it's the specified type.
XmlSerializerSession	build()	Build the object.
XmlSerializerSession.Builder	debug(Boolean value)	Debug mode.
XmlSerializerSession.Builder	fileCharset(Charset value)	File charset.
XmlSerializerSession.Builder	javaMethod(Method value)	The java method that called this serializer, usually the method in a REST servlet.
XmlSerializerSession.Builder	locale(Locale value)	The session locale.
XmlSerializerSession.Builder	localeDefault(Locale value)	Same as BeanSession.Builder.locale(Locale) but doesn't overwrite the value if it is already set.
XmlSerializerSession.Builder	mediaType(MediaType value)	The session media type.
XmlSerializerSession.Builder	mediaTypeDefault(MediaType value)	Same as BeanSession.Builder.mediaType(MediaType) but doesn't overwrite the value if it is already set.
XmlSerializerSession.Builder	properties(Map<String,Object> value)	Session properties.
XmlSerializerSession.Builder	property(String key, Object value)	Adds a property to this session.
XmlSerializerSession.Builder	resolver(VarResolverSession value)	String variable resolver.
XmlSerializerSession.Builder	schema(HttpPartSchema value)	HTTP-part schema.
XmlSerializerSession.Builder	schemaDefault(HttpPartSchema value)	Same as SerializerSession.Builder.schema(HttpPartSchema) but doesn't overwrite the value if it is already set.
XmlSerializerSession.Builder	streamCharset(Charset value)	Output stream charset.
XmlSerializerSession.Builder	timeZone(TimeZone value)	The session timezone.
XmlSerializerSession.Builder	timeZoneDefault(TimeZone value)	Same as BeanSession.Builder.timeZone(TimeZone) but doesn't overwrite the value if it is already set.
XmlSerializerSession.Builder	unmodifiable()	Create an unmodifiable session.
XmlSerializerSession.Builder	uriContext(UriContext value)	URI context bean.
XmlSerializerSession.Builder	useWhitespace(Boolean value)	Use whitespace.

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.

Method Details

build

public XmlSerializerSession build()

Description copied from class: BeanSession.Builder

Build the object.

Overrides:

build in class WriterSerializerSession.Builder

Returns:

The built object.

apply

public <T> XmlSerializerSession.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 WriterSerializerSession.Builder

Type Parameters:

T - The expected type.

Parameters:

type - The expected type.

apply - The consumer to apply.

Returns:

This object.

debug

public XmlSerializerSession.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 WriterSerializerSession.Builder

Parameters:

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

Returns:

This object.

properties

public XmlSerializerSession.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 WriterSerializerSession.Builder

Parameters:

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

Returns:

This object.

property

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

Description copied from class: ContextSession.Builder

Adds a property to this session.

Overrides:

property in class WriterSerializerSession.Builder

Parameters:

key - The property key.

value - The property value.

Returns:

This object.

unmodifiable

public XmlSerializerSession.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 WriterSerializerSession.Builder

Returns:

This object.

locale

public XmlSerializerSession.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 WriterSerializerSession.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 XmlSerializerSession.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 WriterSerializerSession.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 XmlSerializerSession.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 WriterSerializerSession.Builder

Parameters:

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

Returns:

This object.

mediaTypeDefault

public XmlSerializerSession.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 WriterSerializerSession.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 XmlSerializerSession.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 WriterSerializerSession.Builder

Parameters:

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

Returns:

This object.

timeZoneDefault

public XmlSerializerSession.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 WriterSerializerSession.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 XmlSerializerSession.Builder javaMethod(Method value)

Description copied from class: SerializerSession.Builder

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

Overrides:

javaMethod in class WriterSerializerSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

resolver

public XmlSerializerSession.Builder resolver(VarResolverSession value)

Description copied from class: SerializerSession.Builder

String variable resolver.

If not specified, defaults to session created by VarResolver.DEFAULT.

Overrides:

resolver in class WriterSerializerSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

schema

public XmlSerializerSession.Builder schema(HttpPartSchema value)

Description copied from class: SerializerSession.Builder

HTTP-part schema.

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

Overrides:

schema in class WriterSerializerSession.Builder

Parameters:

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

Returns:

This object.

schemaDefault

public XmlSerializerSession.Builder schemaDefault(HttpPartSchema value)

Description copied from class: SerializerSession.Builder

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

Overrides:

schemaDefault in class WriterSerializerSession.Builder

Parameters:

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

Returns:

This object.

uriContext

public XmlSerializerSession.Builder uriContext(UriContext value)

Description copied from class: SerializerSession.Builder

URI context bean.

Bean used for resolution of URIs to absolute or root-relative form.

If not specified, defaults to Serializer.Builder.uriContext(UriContext).

Overrides:

uriContext in class WriterSerializerSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

fileCharset

public XmlSerializerSession.Builder fileCharset(Charset value)

Description copied from class: WriterSerializerSession.Builder

File charset.

The character set to use for writing Files to the file system.

Used when passing in files to Serializer.serialize(Object, Object).

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

Overrides:

fileCharset in class WriterSerializerSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

streamCharset

public XmlSerializerSession.Builder streamCharset(Charset value)

Description copied from class: WriterSerializerSession.Builder

Output stream charset.

The character set to use when writing to OutputStreams.

Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object).

If not specified, defaults to UTF-8.

Overrides:

streamCharset in class WriterSerializerSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.

useWhitespace

public XmlSerializerSession.Builder useWhitespace(Boolean value)

Description copied from class: WriterSerializerSession.Builder

Use whitespace.

If true, whitespace is added to the output to improve readability.

Overrides:

useWhitespace in class WriterSerializerSession.Builder

Parameters:

value - The new property value.
Can be null.

Returns:

This object.