Package org.apache.juneau

Class BeanTraverseSession.Builder

java.lang.Object

org.apache.juneau.ContextSession.Builder

org.apache.juneau.BeanSession.Builder

org.apache.juneau.BeanTraverseSession.Builder

Direct Known Subclasses:

JsonSchemaGeneratorSession.Builder, SerializerSession.Builder

Enclosing class:

BeanTraverseSession

public abstract static class BeanTraverseSession.Builder
extends BeanSession.Builder

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(BeanTraverseContext ctx)	Constructor

Method Summary

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

Methods inherited from class org.apache.juneau.BeanSession.Builder

build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder(BeanTraverseContext ctx)

Constructor

Parameters:

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

Method Details

apply

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

Type Parameters:

T - The expected type.

Parameters:

type - The expected type.
Cannot be null.

apply - The consumer to apply.
Cannot be null.

Returns:

This object.

debug

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

Parameters:

value - The new value for this property.
If null, defaults to Context.isDebug().

Returns:

This object.

locale

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

Parameters:

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

Returns:

This object.

mediaType

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

Parameters:

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

Returns:

This object.

mediaTypeDefault

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

Parameters:

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

Returns:

This object.

properties

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

Parameters:

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

Returns:

This object.

property

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

Description copied from class: ContextSession.Builder

Adds a property to this session.

Overrides:

property in class BeanSession.Builder

Parameters:

key - The property key.
Cannot be null.

value - The property value.
Can be null (removes the property).

Returns:

This object.

timeZone

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

Parameters:

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

Returns:

This object.

timeZoneDefault

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

Parameters:

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

Returns:

This object.

unmodifiable

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

Returns:

This object.