de.siegmar.fastcsv.reader

Class CsvReader.CsvReaderBuilder

java.lang.Object

de.siegmar.fastcsv.reader.CsvReader.CsvReaderBuilder

Enclosing class:

CsvReader

public static final class CsvReader.CsvReaderBuilder
extends java.lang.Object

This builder is used to create configured instances of CsvReader. The default configuration of this class complies with RFC 4180.

The line delimiter (line-feed, carriage-return or the combination of both) is detected automatically and thus not configurable.

Method Summary

Modifier and Type	Method and Description
CsvReader	build(java.nio.file.Path path) Constructs a new CsvReader for the specified path using UTF-8 as the character set.
CsvReader	build(java.nio.file.Path path, java.nio.charset.Charset charset) Constructs a new CsvReader for the specified arguments.
CsvReader	build(java.io.Reader reader) Constructs a new CsvReader for the specified arguments.
CsvReader	build(java.lang.String data) Constructs a new CsvReader for the specified arguments.
CsvReader.CsvReaderBuilder	commentCharacter(char commentCharacter) Sets the commentCharacter used to comment lines.
CsvReader.CsvReaderBuilder	commentStrategy(CommentStrategy commentStrategy) Sets the strategy that defines how (and if) commented lines should be handled (default: CommentStrategy.NONE as comments are not defined in RFC 4180).
CsvReader.CsvReaderBuilder	errorOnDifferentFieldCount(boolean errorOnDifferentFieldCount) Defines if an MalformedCsvException should be thrown if lines do contain a different number of columns.
CsvReader.CsvReaderBuilder	fieldSeparator(char fieldSeparator) Sets the fieldSeparator used when reading CSV data.
CsvReader.CsvReaderBuilder	quoteCharacter(char quoteCharacter) Sets the quoteCharacter used when reading CSV data.
CsvReader.CsvReaderBuilder	skipEmptyRows(boolean skipEmptyRows) Defines if empty rows should be skipped when reading data.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

fieldSeparator

public CsvReader.CsvReaderBuilder fieldSeparator(char fieldSeparator)

Sets the fieldSeparator used when reading CSV data.

Parameters:

fieldSeparator - the field separator character (default: , - comma).

Returns:

This updated object, so that additional method calls can be chained together.

quoteCharacter

public CsvReader.CsvReaderBuilder quoteCharacter(char quoteCharacter)

Sets the quoteCharacter used when reading CSV data.

Parameters:

quoteCharacter - the character used to enclose fields (default: " - double quotes).

Returns:

This updated object, so that additional method calls can be chained together.

commentStrategy

public CsvReader.CsvReaderBuilder commentStrategy(CommentStrategy commentStrategy)

Sets the strategy that defines how (and if) commented lines should be handled (default: CommentStrategy.NONE as comments are not defined in RFC 4180).

Parameters:

commentStrategy - the strategy for handling comments.

Returns:

This updated object, so that additional method calls can be chained together.

See Also:

commentCharacter(char)

commentCharacter

public CsvReader.CsvReaderBuilder commentCharacter(char commentCharacter)

Sets the commentCharacter used to comment lines.

Parameters:

commentCharacter - the character used to comment lines (default: # - hash)

Returns:

This updated object, so that additional method calls can be chained together.

See Also:

commentStrategy(CommentStrategy)

skipEmptyRows

public CsvReader.CsvReaderBuilder skipEmptyRows(boolean skipEmptyRows)

Defines if empty rows should be skipped when reading data.

Parameters:

skipEmptyRows - if empty rows should be skipped (default: true).

Returns:

This updated object, so that additional method calls can be chained together.

errorOnDifferentFieldCount

public CsvReader.CsvReaderBuilder errorOnDifferentFieldCount(boolean errorOnDifferentFieldCount)

Defines if an MalformedCsvException should be thrown if lines do contain a different number of columns.

Parameters:

errorOnDifferentFieldCount - if an exception should be thrown, if CSV data contains different field count (default: false).

Returns:

This updated object, so that additional method calls can be chained together.

build

public CsvReader build(java.io.Reader reader)

Constructs a new CsvReader for the specified arguments.

This library uses built-in buffering, so you do not need to pass in a buffered Reader implementation such as BufferedReader. Performance may be even likely better if you do not.

Use build(Path, Charset) for optimal performance when reading files and build(String) when reading Strings.

Parameters:

reader - the data source to read from.

Returns:

a new CsvReader - never null.

Throws:

java.lang.NullPointerException - if reader is null

build

public CsvReader build(java.lang.String data)

Constructs a new CsvReader for the specified arguments.

Parameters:

data - the data to read.

Returns:

a new CsvReader - never null.

build

public CsvReader build(java.nio.file.Path path)
                throws java.io.IOException

Constructs a new CsvReader for the specified path using UTF-8 as the character set.

Parameters:

path - the file to read data from.

Returns:

a new CsvReader - never null. Don't forget to close it!

Throws:

java.io.IOException - if an I/O error occurs.

java.lang.NullPointerException - if path or charset is null

build

public CsvReader build(java.nio.file.Path path,
                       java.nio.charset.Charset charset)
                throws java.io.IOException

Constructs a new CsvReader for the specified arguments.

Parameters:

path - the file to read data from.

charset - the character set to use.

Returns:

a new CsvReader - never null. Don't forget to close it!

Throws:

java.io.IOException - if an I/O error occurs.

java.lang.NullPointerException - if path or charset is null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object