com.adaptris.core.transform.csv

Class CustomFormatBuilder

java.lang.Object

com.adaptris.core.transform.csv.CustomFormatBuilder

All Implemented Interfaces:

FormatBuilder

public class CustomFormatBuilder
extends java.lang.Object
implements FormatBuilder

Implementation of FormatBuilder that allows for custom csv formats.

In the adapter configuration file this class is aliased as csv-custom-format which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
CustomFormatBuilder()

Method Summary

Modifier and Type	Method and Description
protected static org.apache.commons.csv.CSVFormat	configureCSV(org.apache.commons.csv.CSVFormat obj, java.lang.String[] candidates, java.lang.Class type, java.lang.String optionName, java.lang.Object value)
org.apache.commons.csv.CSVFormat	createFormat() Create the CSVFormat.
java.lang.Character	getCommentStart()
java.lang.Character	getDelimiter()
java.lang.Character	getEscape()
java.lang.Boolean	getIgnoreEmptyLines()
java.lang.Boolean	getIgnoreSurroundingSpaces()
java.lang.Character	getQuoteChar()
java.lang.String	getRecordSeparator()
void	setCommentStart(java.lang.Character commentStart)
void	setDelimiter(java.lang.Character d) Set the delimiter for the CSV file.
void	setEscape(java.lang.Character escape)
void	setIgnoreEmptyLines(java.lang.Boolean b) Specify whether or not to ignore empty lines.
void	setIgnoreSurroundingSpaces(java.lang.Boolean b) Specify whether or not to ignore surrounding spaces.
void	setQuoteChar(java.lang.Character quoteChar)
void	setRecordSeparator(java.lang.String sep) Set the record separactor

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomFormatBuilder

public CustomFormatBuilder()

Method Detail

createFormat

public org.apache.commons.csv.CSVFormat createFormat()

Description copied from interface: FormatBuilder

Create the CSVFormat.

Specified by:

createFormat in interface FormatBuilder

Returns:

the CSV Format.

getDelimiter

public java.lang.Character getDelimiter()

setDelimiter

public void setDelimiter(java.lang.Character d)

Set the delimiter for the CSV file.

Parameters:

d - the delimiter; if not specified, defaults to ","

getCommentStart

public java.lang.Character getCommentStart()

setCommentStart

public void setCommentStart(java.lang.Character commentStart)

getEscape

public java.lang.Character getEscape()

setEscape

public void setEscape(java.lang.Character escape)

getQuoteChar

public java.lang.Character getQuoteChar()

setQuoteChar

public void setQuoteChar(java.lang.Character quoteChar)

getIgnoreEmptyLines

public java.lang.Boolean getIgnoreEmptyLines()

setIgnoreEmptyLines

public void setIgnoreEmptyLines(java.lang.Boolean b)

Specify whether or not to ignore empty lines.

Parameters:

b - true or false, if not specified false.

getIgnoreSurroundingSpaces

public java.lang.Boolean getIgnoreSurroundingSpaces()

setIgnoreSurroundingSpaces

public void setIgnoreSurroundingSpaces(java.lang.Boolean b)

Specify whether or not to ignore surrounding spaces.

Parameters:

b - true or false, if not specified false.

getRecordSeparator

public java.lang.String getRecordSeparator()

setRecordSeparator

public void setRecordSeparator(java.lang.String sep)

Set the record separactor

Parameters:

sep - the record separator; if not specified defaults to "\r\n"

configureCSV

protected static org.apache.commons.csv.CSVFormat configureCSV(org.apache.commons.csv.CSVFormat obj,
                                                               java.lang.String[] candidates,
                                                               java.lang.Class type,
                                                               java.lang.String optionName,
                                                               java.lang.Object value)