info.unterrainer.java.tools.csvtools

Class CsvReader

java.lang.Object

info.unterrainer.java.tools.csvtools.CsvBase

info.unterrainer.java.tools.csvtools.CsvReader

All Implemented Interfaces:

Closeable, AutoCloseable

public class CsvReader
extends CsvBase

The Class CsvReader.

Enables you to read CSV-files using various types of delimiters (column and row) and quotes.

Field Summary

Fields inherited from class info.unterrainer.java.tools.csvtools.CsvBase

columnSeparator, DEFAULT_COLUMN_SEPARATOR, DEFAULT_FIELD_DELIMITER, DEFAULT_ROW_SEPARATOR, fieldDelimiter, lockObject, rowSeparator

Constructor Summary

Constructors

Constructor and Description
CsvReader(@Nullable StringReader stringReader) Initializes a new instance of the CsvReader class.
CsvReader(@Nullable StringReader stringReader, @Nullable Character columnSeparator, @Nullable String rowSeparator, @Nullable String fieldDelimiter, @Nullable Integer readChunkSize) Initializes a new instance of the CsvReader class.
CsvReader(@Nullable StringReader stringReader, char columnSeparator, String rowSeparator, String fieldDelimiter) Initializes a new instance of the CsvReader class.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
@Nullable List<List<String>>	readAllRows() Reads all rows of the CSV and returns them in a List.
@Nullable List<String>	readRow() Returns the next row, already split into fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReader

public CsvReader(@Nullable
                 @Nullable StringReader stringReader)
          throws IllegalArgumentException

Initializes a new instance of the CsvReader class. Call close() on it before moving on in order to close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringReader - The StringReader you want the CsvReader to attach to.

Throws:

IllegalArgumentException - If the provided stringReader is null.

CsvReader

public CsvReader(@Nullable
                 @Nullable StringReader stringReader,
                 char columnSeparator,
                 String rowSeparator,
                 String fieldDelimiter)

Initializes a new instance of the CsvReader class. Call close() on it before moving on in order to close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringReader - The StringReader you want the CsvReader to attach to.

columnSeparator - A delimiter to separate columns (e.g. ';').

rowSeparator - A delimiter to separate rows (e.g. System.getProperty("line.separator")).

fieldDelimiter - A delimiter to enclose special-character-containing strings (e.g. " or just the empty string).

CsvReader

public CsvReader(@Nullable
                 @Nullable StringReader stringReader,
                 @Nullable
                 @Nullable Character columnSeparator,
                 @Nullable
                 @Nullable String rowSeparator,
                 @Nullable
                 @Nullable String fieldDelimiter,
                 @Nullable
                 @Nullable Integer readChunkSize)

Initializes a new instance of the CsvReader class. Call close() on it before moving on in order to close the underlying reader. If you don't do this, the garbage collector will do that for you at an undefined point in time.

Parameters:

stringReader - The StringReader you want the CsvReader to attach to.

columnSeparator - A delimiter to separate columns (e.g. ';').

rowSeparator - A delimiter to separate rows (e.g. System.getProperty("line.separator")).

fieldDelimiter - A delimiter to enclose special-character-containing strings (e.g. " or just the empty string).

readChunkSize - Size of one chunk (the minimal value is rowSeparator.length() and is automatically assigned if the given value was too small). The bufferSize is automatically allocated in any case. It will be readChunkSize + rowSeparator.length() due to the parsing technique used).

Method Detail

readRow

@Nullable
public @Nullable List<String> readRow()
                                          throws IOException

Returns the next row, already split into fields. Returns null if the end of the source is reached.

Returns:

An array of string containing the fields of this row or null if the end of the source has been reached.

Throws:

IOException - If the underlying stream could not be accessed.

readAllRows

@Nullable
public @Nullable List<List<String>> readAllRows()
                                                    throws IOException

Reads all rows of the CSV and returns them in a List. The resulting structure is a List-of-List-of-string.

Returns:

A List-of-List-of-string representing the read CSV-file.

Throws:

IOException - If the underlying stream could not be accessed.

close

public void close()
           throws IOException

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable