Package org.apache.juneau.marshall

Class MarshallingSession.Builder<SELF extends MarshallingSession.Builder<SELF>>

java.lang.Object

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

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

Direct Known Subclasses:

MarshallingSession.DefaultBuilder, MarshallingTraverseSession.Builder, ParserSession.Builder

Enclosing class:

MarshallingSession

public abstract static class MarshallingSession.Builder<SELF extends MarshallingSession.Builder<SELF>>
extends ContextSession.Builder<SELF>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(MarshallingContext ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
SELF	activeView(String value)	Overrides the active view for this session.
MarshallingSession	build()	Build the object.
SELF	locale(Locale value)	The session locale.
SELF	mediaType(MediaType value)	The session media type.
SELF	mediaTypeDefault(MediaType value)	Same as mediaType(MediaType) but doesn't overwrite the value if it is already set.
SELF	property(String key, Object value)	Adds a property to this session.
SELF	timeZone(TimeZone value)	The session timezone.
SELF	timeZoneDefault(TimeZone value)	Same as timeZone(TimeZone) but doesn't overwrite the value if it is already set.

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

Constructor

Parameters:

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

Method Details

build

public MarshallingSession build()

Build the object.

Specified by:

build in class ContextSession.Builder<SELF extends MarshallingSession.Builder<SELF>>

Returns:

The built object.

locale

public SELF locale(Locale value)

The session locale.

Specifies the default locale for serializer and parser sessions.

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

See Also:

• MarshalledConfig.locale()
• MarshallingContext.Builder.locale(Locale)

Parameters:

value - The new value for this property.
If null defaults to MarshallingContext.getLocale()

Returns:

This object.

mediaType

public SELF mediaType(MediaType value)

The session media type.

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

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

See Also:

• MarshalledConfig.mediaType()
• MarshallingContext.Builder.mediaType(MediaType)

Parameters:

value - The new value for this property.
If null defaults to MarshallingContext.getMediaType().

Returns:

This object.

mediaTypeDefault

public SELF mediaTypeDefault(MediaType value)

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

Parameters:

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

Returns:

This object.

activeView

public SELF activeView(String value)

Overrides the active view for this session.

When set, only bean properties whose declared MarshalledProp.view() set contains this view name will be included during serialization. On the parse side, out-of-view properties are routed through the existing unknown/ignored-property mechanism.

This is a per-call override. If not set, the value from MarshallingContext.Builder.activeView(String) is used.

See Also:

• MarshalledProp.view()
• MarshallingContext.Builder.activeView(String)

Parameters:

value - The active view name. Use null to disable view filtering for this call.

Returns:

This object.

Since:

10.0.0

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 ContextSession.Builder<SELF extends MarshallingSession.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.

timeZone

public SELF timeZone(TimeZone value)

The session timezone.

Specifies the default timezone for serializer and parser sessions.

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

See Also:

• MarshalledConfig.timeZone()
• MarshallingContext.Builder.timeZone(TimeZone)

Parameters:

value - The new value for this property.
If null defaults to MarshallingContext.getTimeZone().

Returns:

This object.

timeZoneDefault

public SELF timeZoneDefault(TimeZone value)

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

Parameters:

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

Returns:

This object.