org.supercsv.io

Class CsvBeanWriter

java.lang.Object

org.supercsv.io.AbstractCsvWriter

org.supercsv.io.CsvBeanWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ICsvBeanWriter, ICsvWriter

public class CsvBeanWriter
extends AbstractCsvWriter
implements ICsvBeanWriter

CsvBeanWriter writes a CSV file by mapping each field on the bean to a column in the CSV file (using the supplied name mapping).

Author:

Kasper B. Graversen, James Bassett

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	write(Object source, String... nameMapping) Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns.
void	write(Object source, String[] nameMapping, CellProcessor[] processors) Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns.

Methods inherited from class org.supercsv.io.AbstractCsvWriter

close, flush, getLineNumber, getRowNumber, incrementRowAndLineNo, writeComment, writeHeader, writeRow, writeRow, writeRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.supercsv.io.ICsvWriter

getLineNumber, getRowNumber, writeComment, writeHeader

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface java.io.Flushable

flush

Constructor Detail

CsvBeanWriter

public CsvBeanWriter(Writer writer,
                     CsvPreference preference)

Constructs a new CsvBeanWriter with the supplied Writer and CSV preferences. Note that the writer will be wrapped in a BufferedWriter before accessed.

Parameters:

writer - the writer

preference - the CSV preferences

Throws:

NullPointerException - if writer or preference are null

Method Detail

write

public void write(Object source,
                  String... nameMapping)
           throws IOException

Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns. toString() will be called on each element prior to writing.

Specified by:

write in interface ICsvBeanWriter

Parameters:

source - the object (bean instance) containing the values to write

nameMapping - an array of Strings linking the fields in the bean to their corresponding CSV columns (the array length should match the number of columns). A null entry in the array indicates that the column should be ignored (the column will be empty).

Throws:

IOException - if an I/O error occurred

write

public void write(Object source,
                  String[] nameMapping,
                  CellProcessor[] processors)
           throws IOException

Writes the fields of the object as columns of a CSV file, using the supplied name mapping to map fields to the appropriate columns. toString() will be called on each (processed) element prior to writing.

Specified by:

write in interface ICsvBeanWriter

Parameters:

source - the object (bean instance) containing the values to write

nameMapping - an array of Strings linking the fields in the bean to their corresponding CSV columns (the array length should match the number of columns). A null entry in the array indicates that the column should be ignored (the column will be empty).

processors - an array of CellProcessors used to further process data before it is written (each element in the processors array corresponds with a CSV column - the number of processors should match the number of columns). A null entry indicates no further processing is required (the value returned by toString() will be written as the column value).

Throws:

IOException - if an I/O error occurred