org.openestate.io.core

Class CsvPrinter<Record extends CsvRecord>

java.lang.Object

org.openestate.io.core.CsvPrinter<Record>

Type Parameters:

Record - the class used for a record, that is printed to a CSV file

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

IdxPrinter, Is24CsvPrinter

public abstract class CsvPrinter<Record extends CsvRecord>
extends Object
implements Closeable, Flushable

A general CSV printer, that is bound to a CsvFormat and writes CSV data from CsvRecord objects.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CsvPrinter(org.apache.commons.csv.CSVPrinter printer) Create with specifications of a CSVPrinter.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the printer instance.
void	closeQuietly() Closes the printer instance without throwing exceptions.
void	flush() Flushes the printer instance.
protected void	print(String value) Prints a single CSV value.
protected void	printComment(String comment) Prints a comment.
protected void	println() Prints a record separator (line break).
void	printRecord(Record record) Print a CsvRecord followed by a record separator (line break).
void	printRecords(Iterable<Record> records) Print multiple CsvRecord objects.
protected static String	replaceLineBreaks(String value) Helper function to replace line breaks in a string with <br/> before printing.
protected static String	replaceLineBreaks(String value, String lineBreak) Helper function to replace line breaks in a string with a custom value before printing.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvPrinter

protected CsvPrinter(org.apache.commons.csv.CSVPrinter printer)

Create with specifications of a CSVPrinter.

Parameters:

printer - the CSV printer from commons-csv

Method Detail

close

public void close()
           throws IOException

Closes the printer instance.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if closing failed

closeQuietly

public final void closeQuietly()

Closes the printer instance without throwing exceptions.

flush

public void flush()
           throws IOException

Flushes the printer instance.

Specified by:

flush in interface Flushable

Throws:

IOException - if flushing failed

print

protected void print(String value)
              throws IOException

Prints a single CSV value.

Parameters:

value - CSV value to print

Throws:

IOException - if printing failed

println

protected void println()
                throws IOException

Prints a record separator (line break).

Throws:

IOException - if printing failed

printComment

protected void printComment(String comment)
                     throws IOException

Prints a comment.

Parameters:

comment - comment to print

Throws:

IOException - if printing failed

printRecord

public void printRecord(Record record)
                 throws IOException

Print a CsvRecord followed by a record separator (line break).

Parameters:

record - record to print

Throws:

IOException - if printing failed

printRecords

public void printRecords(Iterable<Record> records)
                  throws IOException

Print multiple CsvRecord objects.

Parameters:

records - records to print

Throws:

IOException - if printing failed

replaceLineBreaks

protected static String replaceLineBreaks(String value)

Helper function to replace line breaks in a string with <br/> before printing.

This method may be used by inheriting classes, if the particular format does not support line breaks.

Parameters:

value - value to replace

Returns:

value with replaced line breaks

replaceLineBreaks

protected static String replaceLineBreaks(String value,
                       String lineBreak)

Helper function to replace line breaks in a string with a custom value before printing.

This method may be used by inheriting classes, if the particular format does not support line breaks.

Parameters:

value - value to replace

lineBreak - value, that is used for replacement of line breaks - if null, <br/> is used

Returns:

value with replaced line breaks