org.apache.juneau.serializer

Class SerializerSessionArgs

java.lang.Object

org.apache.juneau.SessionArgs

org.apache.juneau.BeanSessionArgs

org.apache.juneau.serializer.SerializerSessionArgs

public final class SerializerSessionArgs
extends BeanSessionArgs

Runtime arguments common to all serializer sessions.

This object specifies information such as session locale or URI context.

Field Summary

Fields inherited from class org.apache.juneau.BeanSessionArgs

DEFAULT

Constructor Summary

Constructors

Constructor and Description
SerializerSessionArgs() Constructor
SerializerSessionArgs(ObjectMap properties, Method javaMethod, Locale locale, TimeZone timeZone, MediaType mediaType, UriContext uriContext) Constructor.

Method Summary

Modifier and Type	Method and Description
SerializerSessionArgs	javaMethod(Method javaMethod) The java method that called this serializer, usually the method in a REST servlet.
SerializerSessionArgs	locale(Locale locale) The session locale.
SerializerSessionArgs	mediaType(MediaType mediaType) The session media type.
SerializerSessionArgs	properties(ObjectMap properties) Session-level properties.
SerializerSessionArgs	timeZone(TimeZone timeZone) The session timezone.
SerializerSessionArgs	uriContext(UriContext uriContext) The URI context.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializerSessionArgs

public SerializerSessionArgs()

Constructor

SerializerSessionArgs

public SerializerSessionArgs(ObjectMap properties,
                             Method javaMethod,
                             Locale locale,
                             TimeZone timeZone,
                             MediaType mediaType,
                             UriContext uriContext)

Constructor.

Parameters:

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

javaMethod - The java method that called this serializer, usually the method in a REST servlet.
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.

uriContext - The URI context.
Identifies the current request URI used for resolution of URIs to absolute or root-relative form.

Method Detail

javaMethod

public SerializerSessionArgs javaMethod(Method javaMethod)

The java method that called this serializer, usually the method in a REST servlet.

Parameters:

javaMethod - The java method that called this serializer, usually the method in a REST servlet.
Can be null.

Returns:

This object (for method chaining).

uriContext

public SerializerSessionArgs uriContext(UriContext uriContext)

The URI context.

Parameters:

uriContext - The URI context.
Identifies the current request URI used for resolution of URIs to absolute or root-relative form.

Returns:

This object (for method chaining).

locale

public SerializerSessionArgs locale(Locale locale)

Description copied from class: BeanSessionArgs

The session locale.

Overrides:

locale in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

timeZone

public SerializerSessionArgs timeZone(TimeZone timeZone)

Description copied from class: BeanSessionArgs

The session timezone.

Overrides:

timeZone in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

mediaType

public SerializerSessionArgs mediaType(MediaType mediaType)

Description copied from class: BeanSessionArgs

The session media type.

Overrides:

mediaType in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

properties

public SerializerSessionArgs properties(ObjectMap properties)

Description copied from class: SessionArgs

Session-level properties.

Overrides:

properties in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).