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
BeanSessionArgs(ObjectMap properties, Locale locale, TimeZone timeZone, MediaType mediaType) Deprecated. Use BeanSessionArgs(ObjectMap, Locale, TimeZone, MediaType, HttpPartSchema, Boolean)
BeanSessionArgs(ObjectMap properties, Locale locale, TimeZone timeZone, MediaType mediaType, HttpPartSchema schema, Boolean debug) Constructor.

Method Summary

Modifier and Type	Method and Description
BeanSessionArgs	debug(Boolean debug) Debug mode.
BeanSessionArgs	locale(Locale locale) The session locale.
BeanSessionArgs	mediaType(MediaType mediaType) The session media type.
BeanSessionArgs	properties(ObjectMap properties) Session-level properties.
BeanSessionArgs	timeZone(TimeZone timeZone) The session timezone.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final BeanSessionArgs DEFAULT

Default empty session arguments.

Constructor Detail

BeanSessionArgs

public BeanSessionArgs()

Constructor

BeanSessionArgs

public BeanSessionArgs(ObjectMap properties,
                       Locale locale,
                       TimeZone timeZone,
                       MediaType mediaType,
                       HttpPartSchema schema,
                       Boolean debug)

Constructor.

Parameters:

properties - Session-level properties.
These override context-level properties.
Can be null.

locale - The session locale.
If null, then the locale defined on the context is used.

timeZone - The session timezone.
If null, then the timezone defined on the context is used.

mediaType - The session media type (e.g. "application/json").
Can be null.

schema - The part schema for the serialized part.
Can be null.

debug - Enable debug mode for this session.
Can be null to use the debug setting on the bean context..

BeanSessionArgs

@Deprecated
public BeanSessionArgs(ObjectMap properties,
                                   Locale locale,
                                   TimeZone timeZone,
                                   MediaType mediaType)

Deprecated. Use BeanSessionArgs(ObjectMap, Locale, TimeZone, MediaType, HttpPartSchema, Boolean)

Method Detail

locale

public BeanSessionArgs locale(Locale locale)

The session locale.

Parameters:

locale - The session locale.
If null, then the locale defined on the context is used.

Returns:

This object (for method chaining).

timeZone

public BeanSessionArgs timeZone(TimeZone timeZone)

The session timezone.

Parameters:

timeZone - The session timezone.
If null, then the timezone defined on the context is used.

Returns:

This object (for method chaining).

mediaType

public BeanSessionArgs mediaType(MediaType mediaType)

The session media type.

Parameters:

mediaType - The session media type (e.g. "application/json").
Can be null.

Returns:

This object (for method chaining).

debug

public BeanSessionArgs debug(Boolean debug)

Debug mode.

Parameters:

debug - Debug mode flag.
Can be null.

Returns:

This object (for method chaining).

properties

public BeanSessionArgs properties(ObjectMap properties)

Description copied from class: SessionArgs

Session-level properties.

Overrides:

properties in class SessionArgs

Parameters:

properties - Session-level properties.
These override context-level properties.
Can be null.

Returns:

This object (for method chaining).