FastCSV 4.1.0 · de.siegmar.fastcsv.reader.CsvRecord · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
pack-priv final boolean	comment If the record is a commented record.
pack-priv final String[]	fields The fields this record is composed of.
pack-priv final long	startingLineNumber The starting line number (starting with 1).

Access	Constructor and Description
pack-priv	CsvRecord(final long startingLineNumber, final String[] fields, final boolean comment)

Method Summary

Modifier and Type	Method and Description
public String	Returns: field value, never `null` getField(final int index of the field to return index) Retrieves the value of a field based on its index, with indexing starting from 0.
public int	Returns: the number of fields in this record getFieldCount() Gets the count of fields in this record.
public List<String>	Returns: all fields of this record, never `null` getFields() Retrieves all fields of this record as an unmodifiable list.
public long	Returns: the starting line number of this record, starting from 1 getStartingLineNumber() Provides the line number at which this record originated, starting from 1.
public boolean	Returns: `true` if the record is a commented record isComment() Indicates whether the record is a commented record.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

comment	back to summary
pack-priv final boolean comment If the record is a commented record. Annotations @SuppressWarnings:checkstyle:VisibilityModifier See Also `isComment()`

fields	back to summary
pack-priv final String[] fields The fields this record is composed of. Annotations @SuppressWarnings:checkstyle:VisibilityModifier See Also `getField(int)`, `getFields()`

startingLineNumber	back to summary
pack-priv final long startingLineNumber The starting line number (starting with 1). Annotations @SuppressWarnings:checkstyle:VisibilityModifier See Also `getStartingLineNumber()`

Constructor Detail

CsvRecord	back to summary
pack-priv CsvRecord(final long startingLineNumber, final String[] fields, final boolean comment)

Method Detail

getField back to summary

getField	back to summary
public String getField(final int index) Retrieves the value of a field based on its index, with indexing starting from 0. There is always at least one field, even if the line was empty. If this records holds a comment, the comment is returned by calling this method with index 0. The comment character is not included in the returned value. Parameters index:int index of the field to return Returns:String field value, never `null` Exceptions IndexOutOfBoundsException: if the index is out of range

public String getField(final int index)

Retrieves the value of a field based on its index, with indexing starting from 0.

There is always at least one field, even if the line was empty.

If this records holds a comment, the comment is returned by calling this method with index 0. The comment character is not included in the returned value.

Parameters

index:int: index of the field to return

Returns:String

field value, never null

Exceptions

IndexOutOfBoundsException:: if the index is out of range

getFieldCount back to summary

getFieldCount	back to summary
public int getFieldCount() Gets the count of fields in this record. The minimum number of fields is 1, even if the line was empty. Returns:int the number of fields in this record See Also `CsvReader.CsvReaderBuilder#allowExtraFields(boolean)`, `CsvReader.CsvReaderBuilder#allowMissingFields(boolean)`

public int getFieldCount()

Gets the count of fields in this record.

The minimum number of fields is 1, even if the line was empty.

Returns:int: the number of fields in this record
See Also: CsvReader.CsvReaderBuilder#allowExtraFields(boolean), CsvReader.CsvReaderBuilder#allowMissingFields(boolean)

getFields back to summary

getFields	back to summary
public List<String> getFields() Retrieves all fields of this record as an unmodifiable list. The returned list has a minimum size of 1, even if the line was empty. For empty lines, the first field is an empty string. Returns:List<String> all fields of this record, never `null`

public List<String> getFields()

Retrieves all fields of this record as an unmodifiable list.

The returned list has a minimum size of 1, even if the line was empty. For empty lines, the first field is an empty string.

Returns:List<String>: all fields of this record, never null

getStartingLineNumber back to summary

getStartingLineNumber	back to summary
public long getStartingLineNumber() Provides the line number at which this record originated, starting from 1. This information is particularly valuable in scenarios involving CSV files containing empty lines as well as multi-line or commented records, where the record number may deviate from the line number. Example: `1 foo,bar 2 foo,"multi 3 line bar" 4 (empty, potentially skipped) 5 #commented record (potentially skipped) 6 "latest 7 record"` 1 foo,bar 2 foo,"multi 3 line bar" 4 (empty, potentially skipped) 5 #commented record (potentially skipped) 6 "latest 7 record" The last record (containing the multi-line field "latest\nrecord") would have a starting line number of 6, no matter if empty lines or commented records are skipped or not. A starting offset of 1 is used to be consistent with the line numbers shown of most text editors. Note that this number is only correct if the CSV data was read from the very beginning. If you passed a `java.io.Reader` to the `CsvReader` and have already read from it, the line number will be incorrect. Returns:long the starting line number of this record, starting from 1

public long getStartingLineNumber()

Provides the line number at which this record originated, starting from 1.

This information is particularly valuable in scenarios involving CSV files containing empty lines as well as multi-line or commented records, where the record number may deviate from the line number.

Example:

1 foo,bar
2 foo,"multi
3 line bar"
4                    (empty, potentially skipped)
5 #commented record  (potentially skipped)
6 "latest
7 record"

The last record (containing the multi-line field "latest\nrecord") would have a starting line number of 6, no matter if empty lines or commented records are skipped or not.

A starting offset of 1 is used to be consistent with the line numbers shown of most text editors.

Note that this number is only correct if the CSV data was read from the very beginning. If you passed a java.io.Reader to the CsvReader and have already read from it, the line number will be incorrect.

Returns:long: the starting line number of this record, starting from 1

isComment back to summary

isComment	back to summary
public boolean isComment() Indicates whether the record is a commented record. Retrieve the comment by calling `getField(int)` with index 0. Returns:boolean `true` if the record is a commented record See Also `CsvReader.CsvReaderBuilder#commentStrategy(CommentStrategy)`

public boolean isComment()

Indicates whether the record is a commented record.

Retrieve the comment by calling getField(int) with index 0.

Returns:boolean: true if the record is a commented record
See Also: CsvReader.CsvReaderBuilder#commentStrategy(CommentStrategy)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class CsvRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail