Class NamedCsvRecordHandler

java.lang.Object

de.siegmar.fastcsv.reader.CsvCallbackHandler<NamedCsvRecord>

de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler<NamedCsvRecord>

de.siegmar.fastcsv.reader.NamedCsvRecordHandler

public final class NamedCsvRecordHandler
extends AbstractInternalCsvCallbackHandler<NamedCsvRecord>

A callback handler that returns a NamedCsvRecord for each record.

Example:

NamedCsvRecordHandler handler = NamedCsvRecordHandler.builder()
    .fieldModifier(FieldModifiers.TRIM)
    .header("foo", "bar")
    .build();

This implementation is stateful and must not be reused.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	A builder for NamedCsvRecordHandler.

Nested classes/interfaces inherited from class AbstractInternalCsvCallbackHandler

AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<T>

Field Summary

Fields inherited from class AbstractInternalCsvCallbackHandler

fieldIdx, fieldModifier, fields, maxFields, maxFieldSize, maxRecordSize, recordSize, recordType, startingLineNumber

Method Summary

Modifier and Type	Method	Description
static NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	builder()	Constructs a new builder instance for this class.
protected NamedCsvRecord	buildRecord()	Called at the end of each CSV record to build the actual record representation.
static NamedCsvRecordHandler	of()	Constructs a new instance of this class with default settings.
static NamedCsvRecordHandler	of(Consumer<NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder> configurer)	Constructs a new instance of this class with the given configuration.

Methods inherited from class AbstractInternalCsvCallbackHandler

addField, beginRecord, compactFields, getFieldCount, getRecordType, modifyComment, modifyField, setComment, setEmpty

Methods inherited from class CsvCallbackHandler

terminate

Methods inherited from class Object

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

Method Details

builder

public static NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder builder()

Constructs a new builder instance for this class.

Returns:

the builder

See Also:

• of(Consumer)

of

public static NamedCsvRecordHandler of()

Constructs a new instance of this class with default settings.

Returns:

the new instance

See Also:

• NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder.build()

of

public static NamedCsvRecordHandler of(Consumer<NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder> configurer)

Constructs a new instance of this class with the given configuration.

This is an alternative to the builder pattern for convenience.

Parameters:

configurer - the configuration, must not be null

Returns:

the new instance

Throws:

NullPointerException - if null is passed

IllegalArgumentException - if argument constraints are violated

See Also:

• builder()

buildRecord

protected NamedCsvRecord buildRecord()

Description copied from class: CsvCallbackHandler

Called at the end of each CSV record to build the actual record representation.

Specified by:

buildRecord in class CsvCallbackHandler<NamedCsvRecord>

Returns:

the record or null if the record should be ignored/skipped as it is consumed by the callback handler.