de.siegmar.fastcsv.reader

Class NamedCsvReader.NamedCsvReaderBuilder

java.lang.Object

de.siegmar.fastcsv.reader.NamedCsvReader.NamedCsvReaderBuilder

Enclosing class:

NamedCsvReader

public static final class NamedCsvReader.NamedCsvReaderBuilder
extends java.lang.Object

This builder is used to create configured instances of NamedCsvReader. 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
NamedCsvReader	build(java.nio.file.Path path) Constructs a new NamedCsvReader for the specified path using UTF-8 as the character set.
NamedCsvReader	build(java.nio.file.Path path, java.nio.charset.Charset charset) Constructs a new NamedCsvReader for the specified arguments.
NamedCsvReader	build(java.io.Reader reader) Constructs a new NamedCsvReader for the specified arguments.
NamedCsvReader	build(java.lang.String data) Constructs a new NamedCsvReader for the specified arguments.
NamedCsvReader.NamedCsvReaderBuilder	commentCharacter(char commentCharacter) Sets the commentCharacter used to comment lines.
NamedCsvReader.NamedCsvReaderBuilder	fieldSeparator(char fieldSeparator) Sets the fieldSeparator used when reading CSV data.
NamedCsvReader.NamedCsvReaderBuilder	quoteCharacter(char quoteCharacter) Sets the quoteCharacter used when reading CSV data.
NamedCsvReader.NamedCsvReaderBuilder	skipComments(boolean skipComments) Defines if commented rows should be detected and 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 NamedCsvReader.NamedCsvReaderBuilder 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 NamedCsvReader.NamedCsvReaderBuilder 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.

commentCharacter

public NamedCsvReader.NamedCsvReaderBuilder 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:

skipComments(boolean)

skipComments

public NamedCsvReader.NamedCsvReaderBuilder skipComments(boolean skipComments)

Defines if commented rows should be detected and skipped when reading data.

Parameters:

skipComments - if commented rows should be skipped (default: true).

Returns:

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

build

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

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

Parameters:

path - the file to read data from.

Returns:

a new NamedCsvReader - 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 NamedCsvReader build(java.nio.file.Path path,
                            java.nio.charset.Charset charset)
                     throws java.io.IOException

Constructs a new NamedCsvReader for the specified arguments.

Parameters:

path - the file to read data from.

charset - the character set to use.

Returns:

a new NamedCsvReader - 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 NamedCsvReader build(java.io.Reader reader)

Constructs a new NamedCsvReader 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 NamedCsvReader - never null.

Throws:

java.lang.NullPointerException - if reader is null

build

public NamedCsvReader build(java.lang.String data)

Constructs a new NamedCsvReader for the specified arguments.

Parameters:

data - the data to read.

Returns:

a new NamedCsvReader - never null.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object