Package org.apache.camel.dataformat.csv

Class CsvMarshaller

java.lang.Object

org.apache.camel.dataformat.csv.CsvMarshaller

public abstract class CsvMarshaller
extends Object

This class marshal data into a CSV format.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CsvMarshaller(org.apache.commons.csv.CSVFormat format)

Method Summary

Modifier and Type	Method	Description
static CsvMarshaller	create(org.apache.commons.csv.CSVFormat format, CsvDataFormat dataFormat)	Creates a new instance.
protected org.apache.commons.csv.CSVPrinter	createPrinter(org.apache.camel.Exchange exchange, OutputStream outputStream)	Creates and returns a CSVPrinter.
protected abstract Iterable<?>	getMapRecordValues(Map<?,?> map)	Gets the CSV record values of the given map.
void	marshal(org.apache.camel.Exchange exchange, Object object, OutputStream outputStream)	Marshals the given object into the given stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvMarshaller

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

Method Detail

create

public static CsvMarshaller create(org.apache.commons.csv.CSVFormat format,
                                   CsvDataFormat dataFormat)

Creates a new instance.

Parameters:

format - CSV format

dataFormat - Camel CSV data format

Returns:

New instance

marshal

public void marshal(org.apache.camel.Exchange exchange,
                    Object object,
                    OutputStream outputStream)
             throws org.apache.camel.NoTypeConversionAvailableException,
                    IOException

Marshals the given object into the given stream.

Parameters:

exchange - Exchange (used for access to type conversion)

object - Body to marshal

outputStream - Output stream of the CSV

Throws:

org.apache.camel.NoTypeConversionAvailableException - if the body cannot be converted

IOException - if we cannot write into the given stream

createPrinter

protected org.apache.commons.csv.CSVPrinter createPrinter(org.apache.camel.Exchange exchange,
                                                          OutputStream outputStream)
                                                   throws IOException

Creates and returns a CSVPrinter.

Parameters:

exchange - Exchange (used for access to type conversion). Could NOT be null.

outputStream - Output stream of the CSV. Could NOT be null.

Returns:

a new CSVPrinter. Never null.

Throws:

IOException

getMapRecordValues

protected abstract Iterable<?> getMapRecordValues(Map<?,?> map)

Gets the CSV record values of the given map.

Parameters:

map - Input map

Returns:

CSV record values of the given map