Package org.apache.juneau.marshall.csv

Class CsvParser.Builder

java.lang.Object

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

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

org.apache.juneau.marshall.parser.Parser.Builder<SELF>

org.apache.juneau.marshall.parser.ReaderParser.Builder<CsvParser.Builder>

org.apache.juneau.marshall.csv.CsvParser.Builder

Enclosing class:

CsvParser

public static class CsvParser.Builder
extends ReaderParser.Builder<CsvParser.Builder>

Builder class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CsvParser.Builder	allowNestedStructures(boolean value)	Enables parsing of inline {key:val} and [val;val] notation in cells.
CsvParser	build()	Build the object.
CsvParser.Builder	byteArrayFormat(CsvByteArrayCellFormat value)	Format for parsing byte[] arrays from CSV cells.
CsvParser.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
CsvParser.Builder	nullValue(String value)	String that denotes null when parsing.

Methods inherited from class org.apache.juneau.marshall.parser.ReaderParser.Builder

streamCharset

Methods inherited from class org.apache.juneau.marshall.parser.Parser.Builder

autoCloseStreams, autoCloseStreams, consumes, debugOutputLines, getConsumes, getNulls, listener, nulls, trimStrings, trimStrings, unbuffered, unbuffered

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(CsvParser.Builder copyFrom)

Copy constructor.

Parameters:

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

Builder

protected Builder(CsvParser copyFrom)

Copy constructor.

Parameters:

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

Method Details

nullValue

public CsvParser.Builder nullValue(String value)

String that denotes null when parsing. Must match the serializer's nullValue.

Parameters:

value - The null marker string.

Returns:

This object.

allowNestedStructures

public CsvParser.Builder allowNestedStructures(boolean value)

Enables parsing of inline {key:val} and [val;val] notation in cells.

Parameters:

value - Whether to allow nested structures.

Returns:

This object.

byteArrayFormat

public CsvParser.Builder byteArrayFormat(CsvByteArrayCellFormat value)

Format for parsing byte[] arrays from CSV cells.

Must match the format used by the serializer. Default is CsvByteArrayCellFormat.BASE64.

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 ReaderParser.Builder<CsvParser.Builder>

Returns:

The hashkey of this builder.

build

public CsvParser build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class ReaderParser.Builder<CsvParser.Builder>

Returns:

The built object.

copy

public CsvParser.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class ReaderParser.Builder<CsvParser.Builder>

Returns:

A new mutable copy of this builder.