Package org.apache.juneau.parser

Class ParserSession.Builder

java.lang.Object

org.apache.juneau.ContextSession.Builder

org.apache.juneau.BeanSession.Builder

org.apache.juneau.parser.ParserSession.Builder

Direct Known Subclasses:

InputStreamParserSession.Builder, ReaderParserSession.Builder

Enclosing class:

ParserSession

public static class ParserSession.Builder
extends BeanSession.Builder

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(Parser ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
<T> ParserSession.Builder	apply(Class<T> type, Consumer<T> apply)	Applies a consumer to this builder if it's the specified type.
ParserSession	build()	Build the object.
ParserSession.Builder	debug(Boolean value)	Debug mode.
ParserSession.Builder	javaMethod(Method value)	The java method that called this serializer, usually the method in a REST servlet.
ParserSession.Builder	locale(Locale value)	The session locale.
ParserSession.Builder	mediaType(MediaType value)	The session media type.
ParserSession.Builder	mediaTypeDefault(MediaType value)	Same as BeanSession.Builder.mediaType(MediaType) but doesn't overwrite the value if it is already set.
ParserSession.Builder	outer(Object value)	The outer object for instantiating top-level non-static inner classes.
ParserSession.Builder	properties(Map<String,Object> value)	Session properties.
ParserSession.Builder	property(String key, Object value)	Adds a property to this session.
ParserSession.Builder	schema(HttpPartSchema value)	HTTP-part schema.
ParserSession.Builder	schemaDefault(HttpPartSchema value)	Same as schema(HttpPartSchema) but doesn't overwrite the value if it is already set.
ParserSession.Builder	timeZone(TimeZone value)	The session timezone.
ParserSession.Builder	timeZoneDefault(TimeZone value)	Same as BeanSession.Builder.timeZone(TimeZone) but doesn't overwrite the value if it is already set.
ParserSession.Builder	unmodifiable()	Create an unmodifiable session.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(Parser ctx)

Constructor

Parameters:

ctx - The context creating this session.
Cannot be null.

Method Details

apply

public <T> ParserSession.Builder apply(Class<T> type,
 Consumer<T> apply)

Description copied from class: ContextSession.Builder

Applies a consumer to this builder if it's the specified type.

Overrides:

apply in class BeanSession.Builder

Type Parameters:

T - The expected type.

Parameters:

type - The expected type.
Cannot be null.

apply - The consumer to apply.
Cannot be null.

Returns:

This object.

build

public ParserSession build()

Description copied from class: BeanSession.Builder

Build the object.

Overrides:

build in class BeanSession.Builder

Returns:

The built object.

debug

public ParserSession.Builder debug(Boolean value)

Description copied from class: ContextSession.Builder

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 Context.Builder.debug().

See Also:

• BeanConfig.debug()
• Context.Builder.debug()

Overrides:

debug in class BeanSession.Builder

Parameters:

value - The new value for this property.
If null, defaults to Context.isDebug().

Returns:

This object.

javaMethod

public ParserSession.Builder 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.

locale

public ParserSession.Builder locale(Locale value)

Description copied from class: BeanSession.Builder

The session locale.

Specifies the default locale for serializer and parser sessions.

If not specified, defaults to BeanContext.Builder.locale(Locale).

See Also:

• BeanConfig.locale()
• BeanContext.Builder.locale(Locale)

Overrides:

locale in class BeanSession.Builder

Parameters:

value - The new value for this property.
If null defaults to BeanContext.getLocale()

Returns:

This object.

mediaType

public ParserSession.Builder mediaType(MediaType value)

Description copied from class: BeanSession.Builder

The session media type.

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

If not specified, defaults to BeanContext.Builder.mediaType(MediaType).

See Also:

• BeanConfig.mediaType()
• BeanContext.Builder.mediaType(MediaType)

Overrides:

mediaType in class BeanSession.Builder

Parameters:

value - The new value for this property.
If null defaults to BeanContext.getMediaType().

Returns:

This object.

mediaTypeDefault

public ParserSession.Builder mediaTypeDefault(MediaType value)

Description copied from class: BeanSession.Builder

Same as BeanSession.Builder.mediaType(MediaType) but doesn't overwrite the value if it is already set.

Overrides:

mediaTypeDefault in class BeanSession.Builder

Parameters:

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

Returns:

This object.

outer

public ParserSession.Builder outer(Object value)

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

Parameters:

value - The new property value.
Can be null (no outer object will be used, suitable for static or top-level classes).

Returns:

This object.

properties

public ParserSession.Builder properties(Map<String,Object> value)

Description copied from class: ContextSession.Builder

Session properties.

Session properties are generic key-value pairs that can be passed through the session and made available to any customized serializers/parsers or swaps.

Overrides:

properties in class BeanSession.Builder

Parameters:

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

Returns:

This object.

property

public ParserSession.Builder property(String key,
 Object value)

Description copied from class: ContextSession.Builder

Adds a property to this session.

Overrides:

property in class BeanSession.Builder

Parameters:

key - The property key.
Cannot be null.

value - The property value.
Can be null (removes the property).

Returns:

This object.

schema

public ParserSession.Builder 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 (will not set the value, keeps existing schema or remains null).

Returns:

This object.

schemaDefault

public ParserSession.Builder schemaDefault(HttpPartSchema value)

Same as schema(HttpPartSchema) but doesn't overwrite the value if it is already set.

Parameters:

value - The new value for this property.
If null, the value will not be set (keeps existing schema or remains null).

Returns:

This object.

timeZone

public ParserSession.Builder timeZone(TimeZone value)

Description copied from class: BeanSession.Builder

The session timezone.

Specifies the default timezone for serializer and parser sessions.

If not specified, defaults to BeanContext.Builder.timeZone(TimeZone).

See Also:

• BeanConfig.timeZone()
• BeanContext.Builder.timeZone(TimeZone)

Overrides:

timeZone in class BeanSession.Builder

Parameters:

value - The new value for this property.
If null defaults to BeanContext.getTimeZone().

Returns:

This object.

timeZoneDefault

public ParserSession.Builder timeZoneDefault(TimeZone value)

Description copied from class: BeanSession.Builder

Same as BeanSession.Builder.timeZone(TimeZone) but doesn't overwrite the value if it is already set.

Overrides:

timeZoneDefault in class BeanSession.Builder

Parameters:

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

Returns:

This object.

unmodifiable

public ParserSession.Builder unmodifiable()

Description copied from class: ContextSession.Builder

Create an unmodifiable session.

The created ContextSession object will be unmodifiable which makes it suitable for caching and reuse.

Overrides:

unmodifiable in class BeanSession.Builder

Returns:

This object.