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

Modifier and Type	Field and Description
static SerializerSessionArgs	DEFAULT Default serializer session args.

Constructor Summary

Constructors

Constructor and Description
SerializerSessionArgs()

Method Summary

Modifier and Type	Method and Description
static SerializerSessionArgs	create() Creator.
SerializerSessionArgs	debug(Boolean value) Debug mode.
SerializerSessionArgs	fileCharset(Charset value) File charset.
SerializerSessionArgs	javaMethod(Method value) The java method that called this serializer, usually the method in a REST servlet.
SerializerSessionArgs	locale(Locale value) The session locale.
SerializerSessionArgs	mediaType(MediaType value) The session media type.
SerializerSessionArgs	properties(ObjectMap value) Session-level properties.
SerializerSessionArgs	property(String key, Object value) Adds a property to this session.
SerializerSessionArgs	resolver(VarResolverSession value) String variable resolver.
SerializerSessionArgs	schema(HttpPartSchema value) HTTP-part schema.
SerializerSessionArgs	streamCharset(Charset value) Output stream charset.
SerializerSessionArgs	timeZone(TimeZone value) The session timezone.
ObjectMap	toMap() Returns the properties defined on this object as a simple map for debugging purposes.
SerializerSessionArgs	uriContext(UriContext value) URI context bean.
SerializerSessionArgs	useWhitespace(Boolean value) Use whitespace.

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 SerializerSessionArgs DEFAULT

Default serializer session args.

Constructor Detail

SerializerSessionArgs

public SerializerSessionArgs()

Method Detail

create

public static final SerializerSessionArgs create()

Creator.

Returns:

A new parser session arguments object.

fileCharset

public SerializerSessionArgs fileCharset(Charset value)

File charset.

The character set to use for writing Files to the file system.

Used when passing in files to Serializer.serialize(Object, Object).

If not specified, defaults to the JVM system default charset.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

javaMethod

public SerializerSessionArgs javaMethod(Method value)

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

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

resolver

public SerializerSessionArgs resolver(VarResolverSession value)

String variable resolver.

If not specified, defaults to session created by VarResolver.DEFAULT.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

streamCharset

public SerializerSessionArgs streamCharset(Charset value)

Output stream charset.

The character set to use when writing to OutputStreams.

Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object).

If not specified, defaults to UTF-8.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

uriContext

public SerializerSessionArgs uriContext(UriContext value)

URI context bean.

Bean used for resolution of URIs to absolute or root-relative form.

If not specified, defaults to Serializer.SERIALIZER_uriContext.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

useWhitespace

public SerializerSessionArgs useWhitespace(Boolean value)

Use whitespace.

If true, whitespace is added to the output to improve readability.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

debug

public SerializerSessionArgs debug(Boolean value)

Description copied from class: BeanSessionArgs

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.

Overrides:

debug in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

locale

public SerializerSessionArgs locale(Locale value)

Description copied from class: BeanSessionArgs

The session locale.

Specifies the default locale for serializer and parser sessions.

If not specified, defaults to BeanContext.BEAN_locale.

Overrides:

locale in class BeanSessionArgs

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 SerializerSessionArgs mediaType(MediaType value)

Description copied from class: BeanSessionArgs

The session media type.

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

If not specified, defaults to BeanContext.BEAN_mediaType.

Overrides:

mediaType in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

schema

public SerializerSessionArgs schema(HttpPartSchema value)

Description copied from class: BeanSessionArgs

HTTP-part schema.

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

Overrides:

schema in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

timeZone

public SerializerSessionArgs timeZone(TimeZone value)

Description copied from class: BeanSessionArgs

The session timezone.

Specifies the default timezone for serializer and parser sessions.

If not specified, defaults to BeanContext.BEAN_timeZone.

Overrides:

timeZone in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

properties

public SerializerSessionArgs properties(ObjectMap value)

Description copied from class: SessionArgs

Session-level properties.

Overrides context-level properties.

Overrides:

properties in class BeanSessionArgs

Parameters:

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

Returns:

This object (for method chaining).

property

public SerializerSessionArgs property(String key,
                                      Object value)

Description copied from class: SessionArgs

Adds a property to this session.

Overrides:

property in class BeanSessionArgs

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 BeanSessionArgs

Returns:

A new map containing the properties defined on this object.