Package org.apache.juneau.marshall.csv

Class CsvSerializerSession.Builder

java.lang.Object

org.apache.juneau.marshall.ContextSession.Builder<SELF>

org.apache.juneau.marshall.MarshallingSession.Builder<SELF>

org.apache.juneau.marshall.MarshallingTraverseSession.Builder<SELF>

org.apache.juneau.marshall.serializer.SerializerSession.Builder<SELF>

org.apache.juneau.marshall.serializer.WriterSerializerSession.Builder<CsvSerializerSession.Builder>

org.apache.juneau.marshall.csv.CsvSerializerSession.Builder

Enclosing class:

CsvSerializerSession

public static class CsvSerializerSession.Builder
extends WriterSerializerSession.Builder<CsvSerializerSession.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(CsvSerializer ctx)	Constructor

Method Summary

Modifier and Type	Method	Description
CsvSerializerSession.Builder	allowNestedStructures(boolean value)	Allow nested structures.
CsvSerializerSession	build()	Build the object.
CsvSerializerSession.Builder	byteArrayFormat(CsvByteArrayCellFormat value)	Byte array format.
CsvSerializerSession.Builder	nullValue(String value)	Null value string.
CsvSerializerSession.Builder	property(String key, Object value)	Adds a property to this session.

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializerSession.Builder

maxIndent, quoteChar, streamCharset, useWhitespace

Methods inherited from class org.apache.juneau.marshall.serializer.SerializerSession.Builder

addBeanTypes, addRootType, javaMethod, keepNullProperties, nonDefault, resolver, schema, schemaDefault, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings, uriContext

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession.Builder

initialDepth

Methods inherited from class org.apache.juneau.marshall.MarshallingSession.Builder

activeView, locale, mediaType, mediaTypeDefault, timeZone, timeZoneDefault

Methods inherited from class org.apache.juneau.marshall.ContextSession.Builder

apply, cvt, debug, properties, self, unmodifiable

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder(CsvSerializer ctx)

Constructor

Parameters:

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

Method Details

allowNestedStructures

public CsvSerializerSession.Builder allowNestedStructures(boolean value)

Allow nested structures.

Parameters:

value - The new value for this property.

Returns:

This object.

build

public CsvSerializerSession build()

Description copied from class: MarshallingSession.Builder

Build the object.

Overrides:

build in class WriterSerializerSession.Builder<CsvSerializerSession.Builder>

Returns:

The built object.

byteArrayFormat

public CsvSerializerSession.Builder byteArrayFormat(CsvByteArrayCellFormat value)

Byte array format.

Parameters:

value - The new value for this property.

Returns:

This object.

nullValue

public CsvSerializerSession.Builder nullValue(String value)

Null value string.

Parameters:

value - The new value for this property. Can be null (resets to default).

Returns:

This object.

property

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

Description copied from class: ContextSession.Builder

Adds a property to this session.

If the key matches a known session property (e.g. "debug" or "ContextSession.debug"), the value is converted via BasicConverter and routed to the corresponding typed setter. Unknown keys are stored in the raw session properties map.

Overrides:

property in class WriterSerializerSession.Builder<CsvSerializerSession.Builder>

Parameters:

key - The property key.
Cannot be null.

value - The property value.
Can be null (resets typed properties to their default; removes raw properties).

Returns:

This object.