de.siegmar.fastcsv.reader

Class CsvReader

java.lang.Object

de.siegmar.fastcsv.reader.CsvReader

public final class CsvReader
extends java.lang.Object

This is the main class for reading CSV data.

Constructor Summary

Constructors

Constructor and Description
CsvReader()

Method Summary

Modifier and Type	Method and Description
CsvParser	parse(java.io.File file, java.nio.charset.Charset charset) Constructs a new CsvParser for the specified arguments.
CsvParser	parse(java.nio.file.Path path, java.nio.charset.Charset charset) Constructs a new CsvParser for the specified arguments.
CsvParser	parse(java.io.Reader reader) Constructs a new CsvParser for the specified arguments.
CsvContainer	read(java.io.File file, java.nio.charset.Charset charset) Reads an entire file and returns a CsvContainer containing the data.
CsvContainer	read(java.nio.file.Path path, java.nio.charset.Charset charset) Reads an entire file and returns a CsvContainer containing the data.
CsvContainer	read(java.io.Reader reader) Reads from the provided reader until the end and returns a CsvContainer containing the data.
void	setContainsHeader(boolean containsHeader) Specifies if the first line should be the header (default: false).
void	setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount) Specifies if an exception should be thrown, if CSV data contains different field count (default: false).
void	setFieldSeparator(char fieldSeparator) Sets the field separator character (default: ',' - comma).
void	setSkipEmptyRows(boolean skipEmptyRows) Specifies if empty rows should be skipped (default: true).
void	setTextDelimiter(char textDelimiter) Sets the text delimiter character (default: '"' - double quotes).

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReader

public CsvReader()

Method Detail

setFieldSeparator

public void setFieldSeparator(char fieldSeparator)

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

setTextDelimiter

public void setTextDelimiter(char textDelimiter)

Sets the text delimiter character (default: '"' - double quotes).

setContainsHeader

public void setContainsHeader(boolean containsHeader)

Specifies if the first line should be the header (default: false).

setSkipEmptyRows

public void setSkipEmptyRows(boolean skipEmptyRows)

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

setErrorOnDifferentFieldCount

public void setErrorOnDifferentFieldCount(boolean errorOnDifferentFieldCount)

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

read

public CsvContainer read(java.io.File file,
                         java.nio.charset.Charset charset)
                  throws java.io.IOException

Reads an entire file and returns a CsvContainer containing the data.

Parameters:

file - the file to read data from.

charset - the character set to use - must not be null.

Returns:

the entire file's data - never null.

Throws:

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

read

public CsvContainer read(java.nio.file.Path path,
                         java.nio.charset.Charset charset)
                  throws java.io.IOException

Reads an entire file and returns a CsvContainer containing the data.

Parameters:

path - the file to read data from.

charset - the character set to use - must not be null.

Returns:

the entire file's data - never null.

Throws:

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

read

public CsvContainer read(java.io.Reader reader)
                  throws java.io.IOException

Reads from the provided reader until the end and returns a CsvContainer containing the data. 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.

Parameters:

reader - the data source to read from.

Returns:

the entire file's data - never null.

Throws:

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

parse

public CsvParser parse(java.nio.file.Path path,
                       java.nio.charset.Charset charset)
                throws java.io.IOException

Constructs a new CsvParser for the specified arguments.

Parameters:

path - the file to read data from.

charset - the character set to use - must not be null.

Returns:

a new CsvParser - never null.

Throws:

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

parse

public CsvParser parse(java.io.File file,
                       java.nio.charset.Charset charset)
                throws java.io.IOException

Constructs a new CsvParser for the specified arguments.

Parameters:

file - the file to read data from.

charset - the character set to use - must not be null.

Returns:

a new CsvParser - never null.

Throws:

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

parse

public CsvParser parse(java.io.Reader reader)
                throws java.io.IOException

Constructs a new CsvParser 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.

Parameters:

reader - the data source to read from.

Returns:

a new CsvParser - never null.

Throws:

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