Module de.siegmar.fastcsv

Package de.siegmar.fastcsv.reader

Class NamedCsvRecordHandler

java.lang.Object

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

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

de.siegmar.fastcsv.reader.NamedCsvRecordHandler

public final class NamedCsvRecordHandler
extends AbstractCsvCallbackHandler<NamedCsvRecord>

A callback handler that returns a NamedCsvRecord for each record.

This implementation is stateful and must not be reused.

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String[]	EMPTY_HEADER
private java.lang.String[]	header

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

comment, emptyLine, fieldIdx, fieldModifier, fields, recordSize, startingLineNumber

Constructor Summary

Constructors

Constructor	Description
NamedCsvRecordHandler()	Constructs a new NamedCsvRecordHandler with an empty header.
NamedCsvRecordHandler(FieldModifier fieldModifier)	Constructs a new NamedCsvRecordHandler with the given field modifier.
NamedCsvRecordHandler(FieldModifier fieldModifier, java.lang.String... header)	Constructs a new NamedCsvRecordHandler with the given header and field modifier.
NamedCsvRecordHandler(FieldModifier fieldModifier, java.util.List<java.lang.String> header)	Constructs a new NamedCsvRecordHandler with the given header and field modifier.
NamedCsvRecordHandler(java.lang.String... header)	Constructs a new NamedCsvRecordHandler with the given header.
NamedCsvRecordHandler(java.util.List<java.lang.String> header)	Constructs a new NamedCsvRecordHandler with the given header.

Method Summary

Modifier and Type	Method	Description
protected RecordWrapper<NamedCsvRecord>	buildRecord()	Called at the end of each CSV record to build an object representation of the record.
private void	setHeader(java.lang.String... header)

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

addField, addField, beginRecord, buildWrapper, compactFields, materializeComment, materializeField, modifyComment, modifyField, setComment, 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

Field Detail

EMPTY_HEADER

private static final java.lang.String[] EMPTY_HEADER

header

private java.lang.String[] header

Constructor Detail

NamedCsvRecordHandler

public NamedCsvRecordHandler()

Constructs a new NamedCsvRecordHandler with an empty header.

NamedCsvRecordHandler

public NamedCsvRecordHandler(java.util.List<java.lang.String> header)

Constructs a new NamedCsvRecordHandler with the given header.

Parameters:

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

Throws:

java.lang.NullPointerException - if null is passed

NamedCsvRecordHandler

public NamedCsvRecordHandler(java.lang.String... header)

Constructs a new NamedCsvRecordHandler with the given header.

Parameters:

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

Throws:

java.lang.NullPointerException - if null is passed

NamedCsvRecordHandler

public NamedCsvRecordHandler(FieldModifier fieldModifier)

Constructs a new NamedCsvRecordHandler with the given field modifier.

Parameters:

fieldModifier - the field modifier, must not be null

Throws:

java.lang.NullPointerException - if null is passed

NamedCsvRecordHandler

public NamedCsvRecordHandler(FieldModifier fieldModifier,
                             java.util.List<java.lang.String> header)

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:

java.lang.NullPointerException - if null is passed

NamedCsvRecordHandler

public NamedCsvRecordHandler(FieldModifier fieldModifier,
                             java.lang.String... header)

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:

java.lang.NullPointerException - if null is passed

Method Detail

setHeader

private void setHeader(java.lang.String... header)

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