Class NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder

java.lang.Object

de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder>

de.siegmar.fastcsv.reader.NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder

Enclosing class:

NamedCsvRecordHandler

public static final class NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder
extends AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder>

A builder for NamedCsvRecordHandler.

Field Summary

Fields inherited from class AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder

fieldModifier, maxFields, maxFieldSize, maxRecordSize

Method Summary

Modifier and Type	Method	Description
NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	allowDuplicateHeaderFields(boolean allowDuplicateHeaderFields)	Sets whether duplicate header fields are allowed.
NamedCsvRecordHandler	build()	Builds the NamedCsvRecordHandler instance.
NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	header(String... header)	Sets a predefined header.
NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	header(List<String> header)	Sets the header.
NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	headerValidator(HeaderValidator headerValidator)	Sets a validator that is called once the header is determined – either from the first record (that is not a comment or an empty line) or from a predefined header (see header(String...)).
NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	returnHeader(boolean returnHeader)	Sets whether the header itself should be returned as the first record.
protected NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	self()	Method to be implemented by subclasses to return the correct type.

Methods inherited from class AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder

fieldModifier, maxFields, maxFieldSize, maxRecordSize

Methods inherited from class Object

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

Method Details

allowDuplicateHeaderFields

public NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder allowDuplicateHeaderFields(boolean allowDuplicateHeaderFields)

Sets whether duplicate header fields are allowed.

When set to false, a CsvParseException is thrown if the header contains duplicate fields. When set to true, duplicate fields are allowed. See NamedCsvRecord for details on how duplicate headers are handled.

Parameters:

allowDuplicateHeaderFields - whether duplicate header fields are allowed (default: false)

Returns:

This updated object, allowing additional method calls to be chained together.

header

public NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder header(String... header)

Sets a predefined header.

When not set, the header is taken from the first record (that is not a comment or an empty line).

Parameters:

header - the header, must not be null

Returns:

This updated object, allowing additional method calls to be chained together.

Throws:

NullPointerException - if null is passed

See Also:

• header(List)

header

public NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder header(List<String> header)

Sets the header.

When not set, the header is taken from the first record (that is not a comment or an empty line).

Parameters:

header - the header, must not be null

Returns:

This updated object, allowing additional method calls to be chained together.

Throws:

NullPointerException - if null is passed

See Also:

• header(String...)

headerValidator

public NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder headerValidator(HeaderValidator headerValidator)

Sets a validator that is called once the header is determined – either from the first record (that is not a comment or an empty line) or from a predefined header (see header(String...)). Input without any header (e.g., an empty file) yields no records and is not validated.

The validator must throw an exception (any RuntimeException) if the header is not acceptable. While reading, a CsvParseException (as thrown by the standard validators) propagates as-is; any other exception gets wrapped in one. For a predefined header, the validator is already called by build() and any exception propagates as-is.

The validator is called after the built-in checks (null elements, duplicates) have passed.

Parameters:

headerValidator - the validator, must not be null

Returns:

This updated object, allowing additional method calls to be chained together.

Throws:

NullPointerException - if null is passed

See Also:

• HeaderValidator.containsExactly(String...)
• HeaderValidator.containsAtLeast(String...)

returnHeader

public NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder returnHeader(boolean returnHeader)

Sets whether the header itself should be returned as the first record.

When enabled, the first record returned will be a NamedCsvRecord with the header fields as its fields and as the header.

Parameters:

returnHeader - whether the header should be returned as the first record (default: false)

Returns:

This updated object, allowing additional method calls to be chained together.

self

protected NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder self()

Description copied from class: AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder

Method to be implemented by subclasses to return the correct type.

Specified by:

self in class AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder>

Returns:

This object of subclass type.

build

public NamedCsvRecordHandler build()

Builds the NamedCsvRecordHandler instance.

Returns:

the new instance

Throws:

IllegalArgumentException - if argument constraints are violated (see AbstractInternalCsvCallbackHandler)

CsvParseException - if a predefined header (see header(String...)) contains duplicate fields (see allowDuplicateHeaderFields(boolean)) or is rejected by a configured validator (see headerValidator(HeaderValidator))