Module de.siegmar.fastcsv

Package de.siegmar.fastcsv.reader

Class RecordWrapper<T>

java.lang.Object

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

Type Parameters:

T - the record type

public final class RecordWrapper<T>
extends Object

A wrapper for a record that contains information necessary for the CsvReader in order to determine how to process the record.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	comment
private final boolean	emptyLine
private final int	fieldCount
private final T	wrappedRecord

Constructor Summary

Constructors

Constructor	Description
RecordWrapper(boolean comment, boolean emptyLine, int fieldCount, T wrappedRecord)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
int	getFieldCount()	Returns the number of fields in the record.
T	getWrappedRecord()	Returns the actual record to be returned by the CsvReader.
boolean	isComment()	Returns whether the record denotes a comment.
boolean	isEmptyLine()	Returns whether the record is empty.

Methods inherited from class java.lang.Object

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

Field Details

comment

private final boolean comment

emptyLine

private final boolean emptyLine

fieldCount

private final int fieldCount

wrappedRecord

private final T wrappedRecord

Constructor Details

RecordWrapper

RecordWrapper(boolean comment,
 boolean emptyLine,
 int fieldCount,
 T wrappedRecord)

Constructs a new instance.

The comment and emptyLine parameters are only used if the CsvReader is configured to skip comments and/or empty lines. The fieldCount parameter is only used if the CsvReader is configured to check the number of fields in each record. The wrappedRecord parameter is the actual record to be returned by the CsvReader.

Parameters:

comment - whether the record denotes a comment (to be skipped if CsvReader.CsvReaderBuilder.commentStrategy(CommentStrategy) is set to CommentStrategy.SKIP

emptyLine - whether the record is empty (to be skipped if CsvReader.CsvReaderBuilder.skipEmptyLines(boolean) is set to true)

fieldCount - the number of fields in the record (to be checked against the number of fields in other records if CsvReader.CsvReaderBuilder.ignoreDifferentFieldCount(boolean) is set to false)

wrappedRecord - the actual record to be returned by the CsvReader, must not be null

Method Details

isComment

public boolean isComment()

Returns whether the record denotes a comment.

This method is only used if the CsvReader is configured to skip comments.

Returns:

true if the record denotes a comment

isEmptyLine

public boolean isEmptyLine()

Returns whether the record is empty.

This method is only used if the CsvReader is configured to skip empty lines.

Returns:

true if the record is empty

getFieldCount

public int getFieldCount()

Returns the number of fields in the record.

This method is only used if the CsvReader is configured to check the number of fields in each record.

Returns:

the number of fields in the record

getWrappedRecord

public T getWrappedRecord()

Returns the actual record to be returned by the CsvReader.

Returns:

the actual record to be returned by the CsvReader, never null