org.supercsv.io

Class AbstractCsvWriter

java.lang.Object

org.supercsv.io.AbstractCsvWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ICsvWriter

Direct Known Subclasses:

CsvBeanWriter, CsvListWriter, CsvMapWriter

public abstract class AbstractCsvWriter
extends Object
implements ICsvWriter

Defines the standard behaviour of a CSV writer.

Author:

Kasper B. Graversen, James Bassett

Constructor Summary

Constructors

Constructor and Description
AbstractCsvWriter(Writer writer, CsvPreference preference) Constructs a new AbstractCsvWriter with the supplied writer and preferences.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the underlying writer, flushing it first.
protected String	escapeString(String csvElement) Make a string ready for writing by escaping various characters as specified by the CSV format.
void	flush() Flushes the underlying writer.
int	getLineNumber() Gets the current position in the file.
int	getRowNumber() Gets the current row number (i.e.
protected void	incrementRowAndLineNo() In order to maintain the current row and line numbers, this method must be called at the very beginning of every write method implemented in concrete CSV writers.
void	writeHeader(String... header) Writes the header of the CSV file.
protected void	writeRow(List<?> columns) Writes a List of columns as a line to the CsvWriter.
protected void	writeRow(Object... columns) Writes one or more Object columns as a line to the CsvWriter.
protected void	writeRow(String... columns) Writes one or more String columns as a line to the CsvWriter.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCsvWriter

public AbstractCsvWriter(Writer writer,
                 CsvPreference preference)

Constructs a new AbstractCsvWriter with the supplied writer and preferences.

Parameters:

writer - the stream to write to

preference - the CSV preferences

Throws:

NullPointerException - if writer or preference are null

Method Detail

close

public void close()
           throws IOException

Closes the underlying writer, flushing it first.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

flush

public void flush()
           throws IOException

Flushes the underlying writer.

Specified by:

flush in interface Flushable

Throws:

IOException

escapeString

protected String escapeString(String csvElement)

Make a string ready for writing by escaping various characters as specified by the CSV format. This method also updates the current lineNumber as newlines are encountered in the String to be escaped.

Parameters:

csvElement - an element of a CSV file

Returns:

an escaped version of the element ready for persisting

incrementRowAndLineNo

protected void incrementRowAndLineNo()

In order to maintain the current row and line numbers, this method must be called at the very beginning of every write method implemented in concrete CSV writers. This will allow the correct row/line numbers to be used in any exceptions thrown before writing occurs (e.g. during CellProcessor execution), and means that getLineNumber() and getRowNumber() can be called after writing to return the line/row just written.

getLineNumber

public int getLineNumber()

Gets the current position in the file. The first line of the file is line number 1.

Specified by:

getLineNumber in interface ICsvWriter

getRowNumber

public int getRowNumber()

Gets the current row number (i.e. the number of CSV records - including the header - that have been written). This differs from the lineNumber, which is the number of real lines that have been written to the file. The first row is row 1 (which is typically the header row).

Specified by:

getRowNumber in interface ICsvWriter

writeRow

protected void writeRow(List<?> columns)
                 throws IOException

Writes a List of columns as a line to the CsvWriter.

Parameters:

columns - the columns to write

Throws:

IllegalArgumentException - if columns.size == 0

IOException - If an I/O error occurs

NullPointerException - if columns is null

writeRow

protected void writeRow(Object... columns)
                 throws IOException

Writes one or more Object columns as a line to the CsvWriter.

Parameters:

columns - the columns to write

Throws:

IllegalArgumentException - if columns.length == 0

IOException - If an I/O error occurs

NullPointerException - if columns is null

writeRow

protected void writeRow(String... columns)
                 throws IOException

Writes one or more String columns as a line to the CsvWriter.

Parameters:

columns - the columns to write

Throws:

IllegalArgumentException - if columns.length == 0

IOException - If an I/O error occurs

NullPointerException - if columns is null

writeHeader

public void writeHeader(String... header)
                 throws IOException

Writes the header of the CSV file.

Specified by:

writeHeader in interface ICsvWriter

Parameters:

header - one or more header Strings

Throws:

IOException - if an I/O error occurs