org.jsefa.csv.lowlevel.config

Class CsvLowLevelConfiguration

java.lang.Object

org.jsefa.common.lowlevel.config.LowLevelConfiguration

org.jsefa.rbf.lowlevel.config.RbfLowLevelConfiguration

org.jsefa.csv.lowlevel.config.CsvLowLevelConfiguration

public final class CsvLowLevelConfiguration
extends RbfLowLevelConfiguration

Configuration object for creating a CsvLowLevelSerializer or CsvLowLevelDeserializer. It uses lazy initialization.

Author:

Norman Lahme-Huetig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CsvLowLevelConfiguration.Defaults Set of default configuration values.

Constructor Summary

Constructors

Constructor and Description
CsvLowLevelConfiguration() Constructs a new CsvLowLevelConfiguration.

Method Summary

Methods

Modifier and Type	Method and Description
CsvLowLevelConfiguration	createCopy() Creates a copy of this LowLevelConfiguration.
char	getEscapeCharacter() Returns the escape character.
char	getFieldDelimiter() Returns the delimiter used to separate the CSV fields.
char	getQuoteCharacter() Returns the quote used to surround a field.
EscapeMode	getQuoteCharacterEscapeMode() Returns the escape mode for the quote character.
boolean	getUseDelimiterAfterLastField() Returns true if the last CSV field should end with a delimiter.
void	setEscapeCharacter(char escapeCharacter) Sets the escape character.
void	setFieldDelimiter(char fieldDelimiter) Sets the delimiter to be used to separate the CSV fields.
void	setQuoteCharacter(char quoteCharacter) Sets the quote character.
void	setQuoteCharacterEscapeMode(EscapeMode quoteCharacterEscapeMode) Sets the escape mode for the quote character.
void	setUseDelimiterAfterLastField(boolean useDelimiterAfterLastField) Specifies whether the last CSV field should end with a delimiter or not.

Methods inherited from class org.jsefa.rbf.lowlevel.config.RbfLowLevelConfiguration

getLineFilter, getLineFilterLimit, getSpecialRecordDelimiter, setLineFilter, setLineFilterLimit, setSpecialRecordDelimiter

Methods inherited from class org.jsefa.common.lowlevel.config.LowLevelConfiguration

getLineBreak, setLineBreak

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvLowLevelConfiguration

public CsvLowLevelConfiguration()

Constructs a new CsvLowLevelConfiguration.

Method Detail

createCopy

public CsvLowLevelConfiguration createCopy()

Creates a copy of this LowLevelConfiguration.

Specified by:

createCopy in class LowLevelConfiguration

Returns:

a copy of this LowLevelConfiguration

getFieldDelimiter

public char getFieldDelimiter()

Returns the delimiter used to separate the CSV fields.

Returns:

the delimiter

getQuoteCharacter

public char getQuoteCharacter()

Returns the quote used to surround a field.

Returns:

the quote character

getQuoteCharacterEscapeMode

public EscapeMode getQuoteCharacterEscapeMode()

Returns the escape mode for the quote character.

Returns:

an escape mode

getUseDelimiterAfterLastField

public boolean getUseDelimiterAfterLastField()

Returns true if the last CSV field should end with a delimiter.

Returns:

true, if the last CSV field should end with a delimiter; otherwise false

getEscapeCharacter

public char getEscapeCharacter()

Returns the escape character.

Returns:

the escape character.

setFieldDelimiter

public void setFieldDelimiter(char fieldDelimiter)

Sets the delimiter to be used to separate the CSV fields.

Parameters:

fieldDelimiter - the delimiter

setQuoteCharacter

public void setQuoteCharacter(char quoteCharacter)

Sets the quote character.

Parameters:

quoteCharacter - the quote character

setEscapeCharacter

public void setEscapeCharacter(char escapeCharacter)

Sets the escape character.

Parameters:

escapeCharacter - the escape character

setUseDelimiterAfterLastField

public void setUseDelimiterAfterLastField(boolean useDelimiterAfterLastField)

Specifies whether the last CSV field should end with a delimiter or not.

Parameters:

useDelimiterAfterLastField - true, if the last CSV field should end with a delimiter; otherwise false.

setQuoteCharacterEscapeMode

public void setQuoteCharacterEscapeMode(EscapeMode quoteCharacterEscapeMode)

Sets the escape mode for the quote character.

Parameters:

quoteCharacterEscapeMode - the escape mode