org.apache.juneau.parser

Class ParserSessionArgs

java.lang.Object

org.apache.juneau.SessionArgs

org.apache.juneau.BeanSessionArgs

org.apache.juneau.parser.ParserSessionArgs

public final class ParserSessionArgs
extends BeanSessionArgs

Runtime arguments common to all parser sessions.

Field Summary

Fields

Modifier and Type	Field and Description
static ParserSessionArgs	DEFAULT Default parser session args.

Constructor Summary

Constructors

Constructor and Description
ParserSessionArgs()

Method Summary

Modifier and Type	Method and Description
static ParserSessionArgs	create() Creator.
ParserSessionArgs	debug(Boolean value) Debug mode.
ParserSessionArgs	fileCharset(Charset value) File charset.
ParserSessionArgs	javaMethod(Method value) The java method that called this serializer, usually the method in a REST servlet.
ParserSessionArgs	locale(Locale value) The session locale.
ParserSessionArgs	mediaType(MediaType value) The session media type.
ParserSessionArgs	outer(Object value) The outer object for instantiating top-level non-static inner classes.
ParserSessionArgs	properties(ObjectMap value) Session-level properties.
ParserSessionArgs	property(String key, Object value) Adds a property to this session.
ParserSessionArgs	schema(HttpPartSchema value) HTTP-part schema.
ParserSessionArgs	streamCharset(Charset value) Input stream charset.
ParserSessionArgs	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 ParserSessionArgs DEFAULT

Default parser session args.

Constructor Detail

ParserSessionArgs

public ParserSessionArgs()

Method Detail

create

public static final ParserSessionArgs create()

Creator.

Returns:

A new parser session arguments object.

fileCharset

public ParserSessionArgs fileCharset(Charset value)

File charset.

The character set to use for reading Files from the file system.

Used when passing in files to Parser.parse(Object, Class).

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 ParserSessionArgs 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).

outer

public ParserSessionArgs outer(Object value)

The outer object for instantiating top-level non-static inner classes.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

streamCharset

public ParserSessionArgs streamCharset(Charset value)

Input stream charset.

The character set to use for converting InputStreams and byte arrays to readers.

Used when passing in input streams and byte arrays to Parser.parse(Object, Class).

If not specified, defaults to UTF-8.

Parameters:

value - The new property value.
Can be null.

Returns:

This object (for method chaining).

debug

public ParserSessionArgs 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 ParserSessionArgs 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 ParserSessionArgs 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 ParserSessionArgs 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 ParserSessionArgs 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 ParserSessionArgs 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 ParserSessionArgs 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.