Module de.siegmar.fastcsv

Package de.siegmar.fastcsv.reader

Class IndexedCsvReader.IndexedCsvReaderBuilder

java.lang.Object

de.siegmar.fastcsv.reader.IndexedCsvReader.IndexedCsvReaderBuilder

Enclosing class:

IndexedCsvReader<T>

public static final class IndexedCsvReader.IndexedCsvReaderBuilder
extends Object

This builder is used to create configured instances of IndexedCsvReader. The default configuration of this class adheres 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	Description
IndexedCsvReader.IndexedCsvReaderBuilder	acceptCharsAfterQuotes(boolean acceptCharsAfterQuotes)	Specifies whether the presence of characters between a closing quote and a field separator or the end of a line should be treated as an error or not.
<T> IndexedCsvReader<T>	build(CsvCallbackHandler<T> callbackHandler, Path file)	Constructs a new IndexedCsvReader for the specified callback handler and path using UTF-8 as the character set.
<T> IndexedCsvReader<T>	build(CsvCallbackHandler<T> callbackHandler, Path file, Charset charset)	Constructs a new IndexedCsvReader for the specified arguments.
IndexedCsvReader.IndexedCsvReaderBuilder	commentCharacter(char commentCharacter)	Sets the commentCharacter used to comment lines.
IndexedCsvReader.IndexedCsvReaderBuilder	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).
IndexedCsvReader.IndexedCsvReaderBuilder	fieldSeparator(char fieldSeparator)	Sets the fieldSeparator used when reading CSV data.
IndexedCsvReader.IndexedCsvReaderBuilder	index(CsvIndex csvIndex)	Sets a prebuilt index that should be used for accessing the file.
IndexedCsvReader<CsvRecord>	ofCsvRecord(Path file)	Constructs a new IndexedCsvReader of CsvRecord for the specified path using UTF-8 as the character set.
IndexedCsvReader<CsvRecord>	ofCsvRecord(Path file, Charset charset)	Constructs a new IndexedCsvReader of CsvRecord for the specified arguments.
IndexedCsvReader.IndexedCsvReaderBuilder	pageSize(int pageSize)	Sets the pageSize for pages returned by IndexedCsvReader.readPage(int) (default: 100).
IndexedCsvReader.IndexedCsvReaderBuilder	quoteCharacter(char quoteCharacter)	Sets the quoteCharacter used when reading CSV data.
IndexedCsvReader.IndexedCsvReaderBuilder	statusListener(StatusListener statusListener)	Sets the statusListener to listen for indexer status updates.

Methods inherited from class java.lang.Object

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

Method Details

fieldSeparator

public IndexedCsvReader.IndexedCsvReaderBuilder fieldSeparator(char fieldSeparator)

Sets the fieldSeparator used when reading CSV data.

Parameters:

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

Returns:

This updated object, allowing additional method calls to be chained together.

quoteCharacter

public IndexedCsvReader.IndexedCsvReaderBuilder 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, allowing additional method calls to be chained together.

commentStrategy

public IndexedCsvReader.IndexedCsvReaderBuilder 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, allowing additional method calls to be chained together.

Throws:

IllegalArgumentException - if CommentStrategy.SKIP is passed, as this is not supported

See Also:

• commentCharacter(char)

commentCharacter

public IndexedCsvReader.IndexedCsvReaderBuilder commentCharacter(char commentCharacter)

Sets the commentCharacter used to comment lines.

Parameters:

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

Returns:

This updated object, allowing additional method calls to be chained together.

See Also:

• commentStrategy(CommentStrategy)

acceptCharsAfterQuotes

public IndexedCsvReader.IndexedCsvReaderBuilder acceptCharsAfterQuotes(boolean acceptCharsAfterQuotes)

Specifies whether the presence of characters between a closing quote and a field separator or the end of a line should be treated as an error or not.

Example:

 "a"b,"c"
 

If this is set to true, the value ab will be returned for the first field.

If this is set to false, a CsvParseException will be thrown.

Parameters:

acceptCharsAfterQuotes - allow characters after quotes (default: true).

Returns:

This updated object, allowing additional method calls to be chained together.

statusListener

public IndexedCsvReader.IndexedCsvReaderBuilder statusListener(StatusListener statusListener)

Sets the statusListener to listen for indexer status updates.

Parameters:

statusListener - the status listener.

Returns:

This updated object, allowing additional method calls to be chained together.

index

public IndexedCsvReader.IndexedCsvReaderBuilder index(CsvIndex csvIndex)

Sets a prebuilt index that should be used for accessing the file.

Parameters:

csvIndex - a prebuilt index

Returns:

This updated object, allowing additional method calls to be chained together.

pageSize

public IndexedCsvReader.IndexedCsvReaderBuilder pageSize(int pageSize)

Sets the pageSize for pages returned by IndexedCsvReader.readPage(int) (default: 100).

Parameters:

pageSize - the maximum size of pages.

Returns:

This updated object, allowing additional method calls to be chained together.

ofCsvRecord

public IndexedCsvReader<CsvRecord> ofCsvRecord(Path file)
                                        throws IOException

Constructs a new IndexedCsvReader of CsvRecord for the specified path using UTF-8 as the character set.

Convenience method for build(CsvCallbackHandler, Path, Charset) with CsvRecordHandler as the callback handler and StandardCharsets.UTF_8 as the charset.

Parameters:

file - the file to read data from.

Returns:

a new IndexedCsvReader - never null. Remember to close it!

Throws:

IOException - if an I/O error occurs.

NullPointerException - if file or charset is null

ofCsvRecord

public IndexedCsvReader<CsvRecord> ofCsvRecord(Path file,
 Charset charset)
                                        throws IOException

Constructs a new IndexedCsvReader of CsvRecord for the specified arguments.

Convenience method for build(CsvCallbackHandler, Path, Charset) with CsvRecordHandler as the callback handler.

Parameters:

file - the file to read data from.

charset - the character set to use.

Returns:

a new IndexedCsvReader - never null. Remember to close it!

Throws:

IOException - if an I/O error occurs.

NullPointerException - if file or charset is null

build

public <T> IndexedCsvReader<T> build(CsvCallbackHandler<T> callbackHandler,
 Path file)
                              throws IOException

Constructs a new IndexedCsvReader for the specified callback handler and path using UTF-8 as the character set.

Convenience method for build(CsvCallbackHandler, Path, Charset) with StandardCharsets.UTF_8 as charset.

Type Parameters:

T - the type of the CSV record.

Parameters:

callbackHandler - the callback handler to use.

file - the file to read data from.

Returns:

a new IndexedCsvReader - never null. Remember to close it!

Throws:

IOException - if an I/O error occurs.

NullPointerException - if callbackHandler, file or charset is null

build

public <T> IndexedCsvReader<T> build(CsvCallbackHandler<T> callbackHandler,
 Path file,
 Charset charset)
                              throws IOException

Constructs a new IndexedCsvReader for the specified arguments.

Type Parameters:

T - the type of the CSV record.

Parameters:

callbackHandler - the callback handler to use.

file - the file to read data from.

charset - the character set to use.

Returns:

a new IndexedCsvReader - never null. Remember to close it!

Throws:

IOException - if an I/O error occurs.

NullPointerException - if callbackHandler, file or charset is null