Class CSVWriter

java.lang.Object

ca.phon.csv.CSVWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class CSVWriter
extends Object
implements AutoCloseable, Closeable

Writes data to a CSV file with specified settings.

We escape fields based on the rules defined in RFC4180.

Author:

Cristopher Yates

Constructor Summary

Constructors

Constructor	Description
CSVWriter(Writer writer)	Constructs a new CSVWriter with the provided writer and default values for all other options.
CSVWriter(Writer writer, char separator, CSVQuoteType quoteType, boolean trimSpaces, boolean unixLineEndings, boolean quoteAllFields)	Constructs a new CSVWriter.

Method Summary

Modifier and Type	Method	Description
void	addListener(CSVWriterListener listener)	Adds a listener to the CSVWriter.
void	close()
void	flush()
void	writeNext(String[] row)	Write the provided data as the next line in a CSV.

Methods inherited from class java.lang.Object

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

Constructor Details

CSVWriter

public CSVWriter(Writer writer)

Constructs a new CSVWriter with the provided writer and default values for all other options.

Parameters:

writer - The writer for writing the data to a specified file or buffer.

CSVWriter

public CSVWriter(Writer writer,
 char separator,
 CSVQuoteType quoteType,
 boolean trimSpaces,
 boolean unixLineEndings,
 boolean quoteAllFields)

Constructs a new CSVWriter.

Parameters:

writer - The writer for writing the data to a specified file or buffer.

separator - The character that will go between the fields.

quoteType - The type of quote (single or double) used to surround escaped fields.

trimSpaces - Decides whether to trim whitespace from the starts and ends of the fields.

unixLineEndings - Decides whether to use Unix line endings (LF) or Windows line endings (CRLF).

quoteAllFields - Decides whether to force all fields to be enclosed with quotes.

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

addListener

public void addListener(CSVWriterListener listener)

Adds a listener to the CSVWriter.

writeNext

public void writeNext(String[] row)
               throws IOException

Write the provided data as the next line in a CSV.

Parameters:

row - The data to be written as the next row.

Throws:

IOException