Package org.apache.juneau

Class BeanSession.Builder

java.lang.Object

org.apache.juneau.ContextSession.Builder

org.apache.juneau.BeanSession.Builder

Direct Known Subclasses:

BeanTraverseSession.Builder, ParserSession.Builder

Enclosing class:

BeanSession

public static class BeanSession.Builder
extends ContextSession.Builder

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(BeanContext ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
<T> BeanSession.Builder	apply(Class<T> type, Consumer<T> apply)	Applies a consumer to this builder if it's the specified type.
BeanSession	build()	Build the object.
BeanSession.Builder	debug(Boolean value)	Debug mode.
BeanSession.Builder	locale(Locale value)	The session locale.
BeanSession.Builder	localeDefault(Locale value)	Same as locale(Locale) but doesn't overwrite the value if it is already set.
BeanSession.Builder	mediaType(MediaType value)	The session media type.
BeanSession.Builder	mediaTypeDefault(MediaType value)	Same as mediaType(MediaType) but doesn't overwrite the value if it is already set.
BeanSession.Builder	properties(Map<String,Object> value)	Session properties.
BeanSession.Builder	property(String key, Object value)	Adds a property to this session.
BeanSession.Builder	timeZone(TimeZone value)	The session timezone.
BeanSession.Builder	timeZoneDefault(TimeZone value)	Same as timeZone(TimeZone) but doesn't overwrite the value if it is already set.
BeanSession.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(BeanContext ctx)

Constructor

Parameters:

ctx - The context creating this session.

Method Details

build

public BeanSession build()

Build the object.

Specified by:

build in class ContextSession.Builder

Returns:

The built object.

locale

public BeanSession.Builder locale(Locale value)

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)

Parameters:

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

Returns:

This object.

localeDefault

public BeanSession.Builder localeDefault(Locale value)

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

Parameters:

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

Returns:

This object.

mediaType

public BeanSession.Builder mediaType(MediaType value)

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)

Parameters:

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

Returns:

This object.

mediaTypeDefault

public BeanSession.Builder 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 locale defined on the context is used.

Returns:

This object.

timeZone

public BeanSession.Builder timeZone(TimeZone value)

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)

Parameters:

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

Returns:

This object.

timeZoneDefault

public BeanSession.Builder 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 locale defined on the context is used.

Returns:

This object.

apply

public <T> BeanSession.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 ContextSession.Builder

Type Parameters:

T - The expected type.

Parameters:

type - The expected type.

apply - The consumer to apply.

Returns:

This object.

debug

public BeanSession.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 ContextSession.Builder

Parameters:

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

Returns:

This object.

properties

public BeanSession.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 ContextSession.Builder

Parameters:

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

Returns:

This object.

property

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

Description copied from class: ContextSession.Builder

Adds a property to this session.

Overrides:

property in class ContextSession.Builder

Parameters:

key - The property key.

value - The property value.

Returns:

This object.

unmodifiable

public BeanSession.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 ContextSession.Builder

Returns:

This object.