sirius.kernel.commons

Class CSVWriter

java.lang.Object

sirius.kernel.commons.CSVWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public class CSVWriter
extends Object
implements Closeable

Writes rows of data as CSV (comma separated values) files.

By default ; is used to separate columns and line breaks are used to separate rows. If a column value contains the separator character or a line break, it is quoted using ".

If the quotation character occurs withing an already quoted string, it is escaped using \. If no quotation charater is specified (set to \0), the escape character is used if possible. If quoting or escaping is required but disabled (using \0 for their respective value), an exception will be thrown as no valid output can be generated.

Constructor Summary

Constructors

Constructor and Description
CSVWriter(Writer writer) Creates a new writer sending data to the given writer.

Method Summary

Modifier and Type	Method and Description
void	close()
CSVWriter	withEscape(char escape) Specifies the escape character to use.
CSVWriter	withInputTrimming(boolean trim) Controls if each added cell value of the type String should be trimmed or not By default this is true.
CSVWriter	withQuotation(char quotation) Specifies the quotation character to use.
CSVWriter	withSeparator(char separator) Specifies the separator character to use.
CSVWriter	writeArray(Object... row) Writes the given array of values as row.
CSVWriter	writeList(List<Object> row) Writes the given list of values as row.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVWriter

public CSVWriter(Writer writer)

Creates a new writer sending data to the given writer.

The writer is closed by calling close().

Parameters:

writer - the target to write data to

Method Detail

withSeparator

public CSVWriter withSeparator(char separator)

Specifies the separator character to use.

By default this is ;.

Parameters:

separator - the separator to use

Returns:

the writer itself for fluent method calls

withQuotation

public CSVWriter withQuotation(char quotation)

Specifies the quotation character to use.

By default this is ". Use \0 to disable quotation entirely. Note that quotation is required if columns contain the separator character or a line break.

Parameters:

quotation - the quotation character to use

Returns:

the writer itself for fluent method calls

withEscape

public CSVWriter withEscape(char escape)

Specifies the escape character to use.

By default this is \. Use \0 to disable escaping entirely. Note that escaping is required if columns contain a quotation character inside an already quoted column. Or if values contain the separator character and no quotation is possible (quotation character is \0).

Parameters:

escape - the escape character to use

Returns:

the writer itself for fluent method calls

withInputTrimming

public CSVWriter withInputTrimming(boolean trim)

Controls if each added cell value of the type String should be trimmed or not

By default this is true. Use false if strings should not be trimmed.

Parameters:

trim - the value controlling if strings should be trimmed

Returns:

the writer itself for fluent method calls

writeList

public CSVWriter writeList(List<Object> row)
                    throws IOException

Writes the given list of values as row.

Parameters:

row - the data to write. null values will be completely skipped.

Returns:

the writer itself for fluent method calls

Throws:

IOException - in case of an IO error when writing to the underlying writer

writeArray

public CSVWriter writeArray(Object... row)
                     throws IOException

Writes the given array of values as row.

Parameters:

row - the data to write

Returns:

the writer itself for fluent method calls

Throws:

IOException - in case of an IO error when writing to the underlying writer

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException