net.sf.csv4j
Class CSVReader

java.lang.Object
  net.sf.csv4j.CSVReader

public class CSVReader
extends Object

Reads and parses CSV lines from an input source. Correctly handles quoted fields which contain line terminators. The CSVReader is designed to be similar to Reader classes and in particular is similar to the LineNumberReader in terms of its API.

Since:

1.0

Author:

Shawn Boyce

Constructor Summary

CSVReader(Reader reader)
Constructs a CSV reader with the default options.

CSVReader(Reader reader, char comment)
Constructs a CSV reader with the specified options.

CSVReader(Reader reader, char delimiter, char comment)
Constructs a CSV reader with the specified options.

Method Summary

void	close() Closes the input
int	getLineNumber() Returns the current line number.
List<String>	readLine() Reads and parses the next CSV line from the input.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVReader

public CSVReader(Reader reader)

Constructs a CSV reader with the default options.

Parameters:

reader - input to read from.

CSVReader

public CSVReader(Reader reader,
                 char comment)

Constructs a CSV reader with the specified options.

Parameters:

reader - input to read from. A BufferedReader is recommended for better performance. Note that a LineNumberReader should not be used since it will not be able to track the line numbers correctly (newlines can be escaped in a CSV file).

comment - character indicating line is a comment and should be ignored

CSVReader

public CSVReader(Reader reader,
                 char delimiter,
                 char comment)

Constructs a CSV reader with the specified options.

Parameters:

reader - input to read from. A BufferedReader is recommended for better performance. Note that a LineNumberReader should not be used since it will not be able to track the line numbers correctly (newlines can be escaped in a CSV file).

comment - character indicating line is a comment and should be ignored

delimiter - field delimiter character

Method Detail

getLineNumber

public int getLineNumber()

Returns the current line number. Number only changes after readLine() is invoked.

Returns:

current line number

readLine

public List<String> readLine()
                      throws IOException,
                             ParseException

Reads and parses the next CSV line from the input. Comment lines will be ignored.

Returns:

String list of size 0 if EOF reached; never returns null

Throws:

IOException - if an error occurs reading the input

ParseException - if an error occurs during CSV parsing

close

public void close()
           throws IOException

Closes the input

Throws:

IOException - if an I/O error occurs