org.supercsv.io

Class Tokenizer

java.lang.Object

org.supercsv.io.AbstractTokenizer

org.supercsv.io.Tokenizer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, ITokenizer

public class Tokenizer
extends AbstractTokenizer

Reads the CSV file, line by line. If you want the line-reading functionality of this class, but want to define your own implementation of readColumns(List), then consider writing your own Tokenizer by extending AbstractTokenizer.

Constructor Summary

Constructors

Constructor and Description
Tokenizer(java.io.Reader reader, CsvPreference preferences) Constructs a new Tokenizer, which reads the CSV file, line by line.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUntokenizedRow() Returns the raw (untokenized) CSV row that was just read (which can potentially span multiple lines in the file).
boolean	readColumns(java.util.List<java.lang.String> columns) Reads a CSV row into the supplied List of columns (which can potentially span multiple lines in the file).

Methods inherited from class org.supercsv.io.AbstractTokenizer

close, getLineNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

Tokenizer

public Tokenizer(java.io.Reader reader,
                 CsvPreference preferences)

Constructs a new Tokenizer, which reads the CSV file, line by line.

Parameters:

reader - the reader

preferences - the CSV preferences

Throws:

java.lang.NullPointerException - if reader or preferences is null

Method Detail

readColumns

public boolean readColumns(java.util.List<java.lang.String> columns)
                    throws java.io.IOException

Reads a CSV row into the supplied List of columns (which can potentially span multiple lines in the file). The columns list is cleared as the first operation in the method. Any empty columns ("") will be added to the list as null.

Parameters:

columns - the List of columns to read into

Returns:

true if something was read, or false if EOF

Throws:

java.io.IOException - when an IOException occurs

getUntokenizedRow

public java.lang.String getUntokenizedRow()

Returns the raw (untokenized) CSV row that was just read (which can potentially span multiple lines in the file).

Returns:

the raw (untokenized) CSV row that was just read