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 de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler

AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<T extends AbstractInternalCsvCallbackHandler.AbstractInternalCsvCallbackHandlerBuilder<?>>

Field Summary

Fields inherited from class de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler

comment, emptyLine, fieldIdx, fieldModifier, fields, maxFields, maxFieldSize, maxRecordSize, recordSize, startingLineNumber

Constructor Summary

Constructors

Constructor	Description
NamedCsvRecordHandler()	Deprecated, for removal: This API element is subject to removal in a future version. Use of() instead.
NamedCsvRecordHandler(FieldModifier fieldModifier)	Deprecated, for removal: This API element is subject to removal in a future version. Use builder() or of(Consumer) instead.
NamedCsvRecordHandler(FieldModifier fieldModifier, String... header)	Deprecated, for removal: This API element is subject to removal in a future version. Use builder() or of(Consumer) instead.
NamedCsvRecordHandler(FieldModifier fieldModifier, List<String> header)	Deprecated, for removal: This API element is subject to removal in a future version. Use builder() or of(Consumer) instead.
NamedCsvRecordHandler(String... header)	Deprecated, for removal: This API element is subject to removal in a future version. Use builder() or of(Consumer) instead.
NamedCsvRecordHandler(List<String> header)	Deprecated, for removal: This API element is subject to removal in a future version. Use builder() or of(Consumer) instead.

Method Summary

Modifier and Type	Method	Description
static NamedCsvRecordHandler.NamedCsvRecordHandlerBuilder	builder()	Constructs a new builder instance for this class.
protected RecordWrapper<NamedCsvRecord>	buildRecord()	Called at the end of each CSV record to build an object representation of the record.
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 de.siegmar.fastcsv.reader.AbstractInternalCsvCallbackHandler

addField, beginRecord, buildWrapper, compactFields, modifyComment, modifyField, setComment

Methods inherited from class de.siegmar.fastcsv.reader.CsvCallbackHandler

terminate

Methods inherited from class java.lang.Object

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

Constructor Details

NamedCsvRecordHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public NamedCsvRecordHandler()

Deprecated, for removal: This API element is subject to removal in a future version.

Use of() instead.

Constructs a new NamedCsvRecordHandler with an empty header.

NamedCsvRecordHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public NamedCsvRecordHandler(List<String> header)

Deprecated, for removal: This API element is subject to removal in a future version.

Use builder() or of(Consumer) instead.

Constructs a new NamedCsvRecordHandler with the given header.

Parameters:

header - the header, must not be null or contain null elements

Throws:

NullPointerException - if null is passed

NamedCsvRecordHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public NamedCsvRecordHandler(String... header)

Deprecated, for removal: This API element is subject to removal in a future version.

Use builder() or of(Consumer) instead.

Constructs a new NamedCsvRecordHandler with the given header.

Parameters:

header - the header, must not be null or contain null elements

Throws:

NullPointerException - if null is passed

NamedCsvRecordHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public NamedCsvRecordHandler(FieldModifier fieldModifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Use builder() or of(Consumer) instead.

Constructs a new NamedCsvRecordHandler with the given field modifier.

Parameters:

fieldModifier - the field modifier, must not be null

Throws:

NullPointerException - if null is passed

NamedCsvRecordHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public NamedCsvRecordHandler(FieldModifier fieldModifier,
 List<String> header)

Deprecated, for removal: This API element is subject to removal in a future version.

Use builder() or of(Consumer) instead.

Constructs a new NamedCsvRecordHandler with the given header and field modifier.

Parameters:

fieldModifier - the field modifier, must not be null

header - the header, must not be null or contain null elements

Throws:

NullPointerException - if null is passed

NamedCsvRecordHandler

@Deprecated(since="3.6.0",
            forRemoval=true)
public NamedCsvRecordHandler(FieldModifier fieldModifier,
 String... header)

Deprecated, for removal: This API element is subject to removal in a future version.

Use builder() or of(Consumer) instead.

Constructs a new NamedCsvRecordHandler with the given header and field modifier.

Parameters:

fieldModifier - the field modifier, must not be null

header - the header, must not be null or contain null elements

Throws:

NullPointerException - if null is passed

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 RecordWrapper<NamedCsvRecord> buildRecord()

Description copied from class: CsvCallbackHandler

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

The returned wrapper is used by the CsvReader in order to determine how to process the record.

Specified by:

buildRecord in class CsvCallbackHandler<NamedCsvRecord>

Returns:

the record wrapper or null if the record should be ignored/skipped