org.apache.juneau

Class BeanSessionArgs

java.lang.Object

org.apache.juneau.SessionArgs

org.apache.juneau.BeanSessionArgs

Direct Known Subclasses:

ParserSessionArgs, SerializerSessionArgs

public class BeanSessionArgs
extends SessionArgs

Runtime arguments common to all bean, serializer, and parser sessions.

Field Summary

Fields

Modifier and Type	Field and Description
static BeanSessionArgs	DEFAULT Default empty session arguments.

Constructor Summary

Constructors

Constructor and Description
BeanSessionArgs() Constructor

Method Summary

Modifier and Type	Method and Description
static BeanSessionArgs	create() Static creator method.
BeanSessionArgs	debug(Boolean value) Debug mode.
BeanSessionArgs	locale(Locale value) The session locale.
BeanSessionArgs	mediaType(MediaType value) The session media type.
BeanSessionArgs	properties(ObjectMap value) Session-level properties.
BeanSessionArgs	property(String key, Object value) Adds a property to this session.
BeanSessionArgs	schema(HttpPartSchema value) HTTP-part schema.
BeanSessionArgs	timeZone(TimeZone value) The session timezone.
ObjectMap	toMap() Returns the properties defined on this object as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.SessionArgs

getProperty, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final BeanSessionArgs DEFAULT

Default empty session arguments.

Constructor Detail

BeanSessionArgs

public BeanSessionArgs()

Constructor

Method Detail

create

public static BeanSessionArgs create()

Static creator method.

Returns:

A new BeanSessionArgs object.

debug

public BeanSessionArgs debug(Boolean value)

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 BeanContext.BEAN_debug.

Parameters:

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

Returns:

This object (for method chaining).

locale

public BeanSessionArgs locale(Locale value)

The session locale.

Specifies the default locale for serializer and parser sessions.

If not specified, defaults to BeanContext.BEAN_locale.

Parameters:

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

Returns:

This object (for method chaining).

mediaType

public BeanSessionArgs mediaType(MediaType value)

The session media type.

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

If not specified, defaults to BeanContext.BEAN_mediaType.

Parameters:

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

Returns:

This object (for method chaining).

schema

public BeanSessionArgs schema(HttpPartSchema value)

HTTP-part schema.

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

Parameters:

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

Returns:

This object (for method chaining).

timeZone

public BeanSessionArgs timeZone(TimeZone value)

The session timezone.

Specifies the default timezone for serializer and parser sessions.

If not specified, defaults to BeanContext.BEAN_timeZone.

Parameters:

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

Returns:

This object (for method chaining).

properties

public BeanSessionArgs properties(ObjectMap value)

Description copied from class: SessionArgs

Session-level properties.

Overrides context-level properties.

Overrides:

properties in class SessionArgs

Parameters:

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

Returns:

This object (for method chaining).

property

public BeanSessionArgs property(String key,
                                Object value)

Description copied from class: SessionArgs

Adds a property to this session.

Overrides:

property in class SessionArgs

Parameters:

key - The property key.

value - The property value.

Returns:

This object (for method chaining).

toMap

public ObjectMap toMap()

Description copied from class: SessionArgs

Returns the properties defined on this object as a simple map for debugging purposes.

Overrides:

toMap in class SessionArgs

Returns:

A new map containing the properties defined on this object.