Package org.apache.juneau.serializer

Class SerializerSession.Builder

java.lang.Object

org.apache.juneau.ContextSession.Builder

org.apache.juneau.BeanSession.Builder

org.apache.juneau.BeanTraverseSession.Builder

org.apache.juneau.serializer.SerializerSession.Builder

Direct Known Subclasses:

OutputStreamSerializerSession.Builder, WriterSerializerSession.Builder

Enclosing class:

SerializerSession

public static class SerializerSession.Builder
extends BeanTraverseSession.Builder

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(Serializer ctx)	Constructor

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(Serializer ctx)

Constructor

Parameters:

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

Method Details

apply

public <T> SerializerSession.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 BeanTraverseSession.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 SerializerSession build()

Description copied from class: BeanSession.Builder

Build the object.

Overrides:

build in class BeanSession.Builder

Returns:

The built object.

debug

public SerializerSession.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 BeanTraverseSession.Builder

Parameters:

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

Returns:

This object.

javaMethod

public SerializerSession.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 (value will not be set, existing value will be kept).

Returns:

This object.

locale

public SerializerSession.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 BeanTraverseSession.Builder

Parameters:

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

Returns:

This object.

mediaType

public SerializerSession.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 BeanTraverseSession.Builder

Parameters:

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

Returns:

This object.

mediaTypeDefault

public SerializerSession.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 BeanTraverseSession.Builder

Parameters:

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

Returns:

This object.

properties

public SerializerSession.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 BeanTraverseSession.Builder

Parameters:

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

Returns:

This object.

property

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

Description copied from class: ContextSession.Builder

Adds a property to this session.

Overrides:

property in class BeanTraverseSession.Builder

Parameters:

key - The property key.
Cannot be null.

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

Returns:

This object.

resolver

public SerializerSession.Builder 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 (value will not be set, defaults to session created by VarResolver.DEFAULT when accessed).

Returns:

This object.

schema

public SerializerSession.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 (value will not be set, existing value will be kept).

Returns:

This object.

schemaDefault

public SerializerSession.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, then the locale defined on the context is used.

Returns:

This object.

timeZone

public SerializerSession.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 BeanTraverseSession.Builder

Parameters:

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

Returns:

This object.

timeZoneDefault

public SerializerSession.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 BeanTraverseSession.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 SerializerSession.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 BeanTraverseSession.Builder

Returns:

This object.

uriContext

public SerializerSession.Builder uriContext(UriContext value)

URI context bean.

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

If not specified, defaults to Serializer.Builder.uriContext(UriContext).

Parameters:

value - The new property value.
Can be null (value will not be set, defaults to Serializer.Builder.uriContext(UriContext) from context).

Returns:

This object.