org.openestate.io.core

Class CsvFormat<Parser extends CsvParser,Printer extends CsvPrinter>

java.lang.Object

org.openestate.io.core.CsvFormat<Parser,Printer>

Type Parameters:

Parser - the class used for CSV parsing

Printer - the class used for CSV printing

Direct Known Subclasses:

IdxFormat, Is24CsvFormat

public abstract class CsvFormat<Parser extends CsvParser,Printer extends CsvPrinter>
extends Object

A general CSV format specification, that supports reading through CsvParser and writing through CsvPrinter.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CsvFormat(org.apache.commons.csv.CSVFormat format) Create with specifications of a CSVFormat.

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getEncoding() Returns the encoding of created CSV data.
org.apache.commons.csv.CSVFormat	getFormat() Returns the contained CSVFormat.
protected abstract Parser	newParser(org.apache.commons.csv.CSVParser parser) Creates a new CsvParser for a CSVParser.
protected abstract Printer	newPrinter(org.apache.commons.csv.CSVPrinter printer) Creates a new CsvPrinter for a CSVPrinter.
Parser	parse(File csvFile) Creates a CsvParser from a File with CSV data.
Parser	parse(InputStream input) Creates a CsvParser from an InputStream with CSV data.
Parser	parse(Reader input) Creates a CsvParser from a Reader with CSV data.
Parser	parse(String csvString) Creates a CsvParser from a String with CSV data.
protected Printer	print(Appendable output) Creates a CsvPrinter, that writes CSV data into an Appendable object.
Printer	print(File csvFile) Creates a CsvPrinter, that writes CSV data into a File.
Printer	print(OutputStream output) Creates a CsvPrinter, that writes CSV data into an OutputStream.
Printer	print(StringBuffer csvString) Creates a CsvPrinter, that writes CSV data into a StringBuffer.
Printer	print(StringBuilder csvString) Creates a CsvPrinter, that writes CSV data into a StringBuilder.
Printer	print(Writer output) Creates a CsvPrinter, that writes CSV data into a Writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvFormat

protected CsvFormat(org.apache.commons.csv.CSVFormat format)

Create with specifications of a CSVFormat.

Parameters:

format - the CSV format from commons-csv

Method Detail

getEncoding

public abstract String getEncoding()

Returns the encoding of created CSV data.

Returns:

encoding

getFormat

public final org.apache.commons.csv.CSVFormat getFormat()

Returns the contained CSVFormat.

Returns:

the contained format

newParser

protected abstract Parser newParser(org.apache.commons.csv.CSVParser parser)

Creates a new CsvParser for a CSVParser.

Parameters:

parser - the CSV parser from commons-csv

Returns:

created parser

newPrinter

protected abstract Printer newPrinter(org.apache.commons.csv.CSVPrinter printer)

Creates a new CsvPrinter for a CSVPrinter.

Parameters:

printer - the CSV printer from commons-csv

Returns:

created printer

parse

public final Parser parse(String csvString)
                                     throws IOException

Creates a CsvParser from a String with CSV data.

Parameters:

csvString - CSV string

Returns:

created parser

Throws:

IOException - if CSV is not readable

parse

public final Parser parse(File csvFile)
                                     throws IOException

Creates a CsvParser from a File with CSV data.

Parameters:

csvFile - CSV file

Returns:

created parser

Throws:

IOException - if CSV is not readable

parse

public final Parser parse(InputStream input)
                                     throws IOException

Creates a CsvParser from an InputStream with CSV data.

Parameters:

input - CSV input

Returns:

created parser

Throws:

IOException - if CSV is not readable

parse

public Parser parse(Reader input)
                               throws IOException

Creates a CsvParser from a Reader with CSV data.

Parameters:

input - CSV input

Returns:

created parser

Throws:

IOException - if CSV is not readable

print

public final Printer print(StringBuffer csvString)
                                       throws IOException

Creates a CsvPrinter, that writes CSV data into a StringBuffer.

Parameters:

csvString - where CSV is written to

Returns:

created printer

Throws:

IOException - if CSV is not writable

print

public final Printer print(StringBuilder csvString)
                                       throws IOException

Creates a CsvPrinter, that writes CSV data into a StringBuilder.

Parameters:

csvString - where CSV is written to

Returns:

created printer

Throws:

IOException - if CSV is not writable

print

public final Printer print(File csvFile)
                                       throws IOException

Creates a CsvPrinter, that writes CSV data into a File.

Parameters:

csvFile - where CSV is written to

Returns:

created printer

Throws:

IOException - if CSV is not writable

print

public final Printer print(OutputStream output)
                                       throws IOException

Creates a CsvPrinter, that writes CSV data into an OutputStream.

Parameters:

output - where CSV is written to

Returns:

created printer

Throws:

IOException - if CSV is not writable

print

public final Printer print(Writer output)
                                       throws IOException

Creates a CsvPrinter, that writes CSV data into a Writer.

Parameters:

output - where CSV is written to

Returns:

created printer

Throws:

IOException - if CSV is not writable

print

protected Printer print(Appendable output)
                                    throws IOException

Creates a CsvPrinter, that writes CSV data into an Appendable object.

Use this function to, to override the print methods through inheritance.

Parameters:

output - where CSV is written to

Returns:

created printer

Throws:

IOException - if CSV is not writable