Package org.apache.juneau.marshall.csv

Class CsvSerializer.Builder

java.lang.Object

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

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

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

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

org.apache.juneau.marshall.serializer.WriterSerializer.Builder<CsvSerializer.Builder>

org.apache.juneau.marshall.csv.CsvSerializer.Builder

Enclosing class:

CsvSerializer

public static class CsvSerializer.Builder
extends WriterSerializer.Builder<CsvSerializer.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor, default settings.
protected	Builder(CsvSerializer copyFrom)	Copy constructor.
protected	Builder(CsvSerializer.Builder copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
CsvSerializer.Builder	allowNestedStructures(boolean value)	Enables inline {key:val} and [val;val] notation in cells for nested beans, maps, and lists.
CsvSerializer	build()	Build the object.
CsvSerializer.Builder	byteArrayFormat(CsvByteArrayCellFormat value)	Format for serializing byte[] arrays in CSV cells.
CsvSerializer.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
CsvSerializer.Builder	nullValue(String value)	String to write for null values.

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

maxIndent, quoteChar, quoteCharOverride, sq, streamCharset, useWhitespace, useWhitespace, ws

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

accept, addBeanTypes, addBeanTypes, addRootType, addRootType, getAccept, getProduces, keepNullProperties, keepNullProperties, listener, nonDefault, nonDefault, produces, sortCollections, sortCollections, sortMaps, sortMaps, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimStrings, trimStrings, uriContext, uriRelativity, uriResolution

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

detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, maxDepth

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

activeView, annotations, beanClassVisibility, beanConstructorVisibility, beanDictionary, beanFieldVisibility, beanInterceptor, beanMapPutReturnsOldValue, beanMethodVisibility, beanProperties, beanProperties, beanProperties, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSettersForGetters, bigNumberFormat, binaryFormat, bitSetFormat, booleanFormat, calendarFormat, classFormat, classLoader, currencyFormat, dateFormat, debug, dictionaryOn, disableBeansRequireSomeProperties, disableDefaultViewInclusion, disableIgnoreMissingSetters, disableIgnoreTransientFields, disableIgnoreUnknownNullBeanProperties, disableInterfaceProxies, durationFormat, enumFormat, example, example, findFluentSetters, findFluentSetters, floatFormat, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignoreUnknownBeanProperties, ignoreUnknownEnumValues, implClass, implClasses, interfaceClass, interfaces, locale, localeFormat, marshallingContext, marshallingContext, marshallingContext, marshallingContext, mediaType, notBeanClasses, notBeanPackages, periodFormat, propertyNamer, propertyNamer, recordComponentOrder, stopClass, swap, swap, swaps, swaps, temporalFormat, timeZone, timeZoneFormat, typeName, typePropertyName, typePropertyName, unsortedProperties, unsortedProperties, useJavaBeanIntrospector, uuidFormat, validateSchema, validateSchema

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

annotations, apply, applyAnnotations, applyAnnotations, asSubtype, build, cache, canApply, copyOrNull, debug, getApplied, getType, impl, isDebug, registerBuilders, self, type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor, default settings.

Builder

protected Builder(CsvSerializer.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.
Cannot be null.

Builder

protected Builder(CsvSerializer copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.
Cannot be null.

Method Details

nullValue

public CsvSerializer.Builder nullValue(String value)

String to write for null values. Parser treats cells matching this as null.

Default is <NULL> to avoid confusion with the literal string "null".

Parameters:

value - The null marker string.

Returns:

This object.

allowNestedStructures

public CsvSerializer.Builder allowNestedStructures(boolean value)

Enables inline {key:val} and [val;val] notation in cells for nested beans, maps, and lists.

Parameters:

value - Whether to allow nested structures.

Returns:

This object.

byteArrayFormat

public CsvSerializer.Builder byteArrayFormat(CsvByteArrayCellFormat value)

Format for serializing byte[] arrays in CSV cells.

Default is CsvByteArrayCellFormat.BASE64 (matches JSON).

Parameters:

value - The format to use.

Returns:

This object.

hashKey

public HashKey hashKey()

Description copied from class: Context.Builder

Returns the hashkey of this builder.

Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

Overrides:

hashKey in class WriterSerializer.Builder<CsvSerializer.Builder>

Returns:

The hashkey of this builder.

build

public CsvSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class WriterSerializer.Builder<CsvSerializer.Builder>

Returns:

The built object.

copy

public CsvSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class WriterSerializer.Builder<CsvSerializer.Builder>

Returns:

A new mutable copy of this builder.