org.apache.commons.csv.writer

Class CSVConfig


public class CSVConfig
extends java.lang.Object

The CSVConfig is used to configure the CSV writer
Version:
$Id: $
Author:
Martin van den Bemt

Field Summary

static int
FILLLEFT
Fill content the the left.
static int
FILLNONE
Do no do any filling *
static int
FILLRIGHT
Fill content to the right.
private char
delimiter
The seperator character.
private boolean
endTrimmed
Specifies if the end of the line needs to be trimmed
private boolean
fieldHeader
Specifies if we want to use a field header
private List
fields
list of fields *
private int
fill
The fill pattern
private char
fillChar
The fill char.
private boolean
fixedWidth
specifies if it is a fixed width csv file *
private boolean
ignoreDelimiter
Should we ignore the delimiter.
private boolean
ignoreValueDelimiter
Should we ignore the value delimiter.
private char
valueDelimiter
the value delimiter.

Constructor Summary

CSVConfig()

Method Summary

void
addField(CSVField field)
boolean
equals(Object obj)
TODO..
char
getDelimiter()
CSVField
getField(String name)
CSVField[]
getFields()
int
getFill()
char
getFillChar()
char
getValueDelimiter()
static CSVConfig
guessConfig(InputStream inputStream)
Creates a config based on a stream.
boolean
isDelimiterIgnored()
boolean
isEndTrimmed()
boolean
isFieldHeader()
boolean
isFixedWidth()
boolean
isValueDelimiterIgnored()
void
setDelimiter(char delimiter)
Set the delimiter to use
void
setEndTrimmed(boolean endTrimmed)
Specify if the end of the line needs to be trimmed.
void
setFieldHeader(boolean fieldHeader)
Specify if you want to use a field header.
void
setFields(Collection csvField)
Set the fields that should be used by the writer
void
setFields(CSVField[] csvFields)
Set the fields that should be used by the writer.
void
setFill(int fill)
Set the fill pattern.
void
setFillChar(char fillChar)
Set the fill char
void
setFixedWidth(boolean fixedWidth)
Specify if the CSV file is fixed width.
void
setIgnoreDelimiter(boolean ignoreDelimiter)
Specify if the writer should ignore the delimiter.
void
setIgnoreValueDelimiter(boolean ignoreValueDelimiter)
Specify if the writer should ignore the value delimiter.
void
setValueDelimiter(char valueDelimiter)
Set the value delimiter to use

Field Details

FILLLEFT

public static final int FILLLEFT
Fill content the the left. Mainly usable together with fixedWidth *
Field Value:
1

FILLNONE

public static final int FILLNONE
Do no do any filling *
Field Value:
0

FILLRIGHT

public static final int FILLRIGHT
Fill content to the right. Mainly usable together with fixedWidth *
Field Value:
2

delimiter

private char delimiter
The seperator character. Defaults to ,

endTrimmed

private boolean endTrimmed
Specifies if the end of the line needs to be trimmed

fieldHeader

private boolean fieldHeader
Specifies if we want to use a field header

fields

private List fields
list of fields *

fill

private int fill
The fill pattern

fillChar

private char fillChar
The fill char. Defaults to a space

fixedWidth

private boolean fixedWidth
specifies if it is a fixed width csv file *

ignoreDelimiter

private boolean ignoreDelimiter
Should we ignore the delimiter. Defaults to false

ignoreValueDelimiter

private boolean ignoreValueDelimiter
Should we ignore the value delimiter. Defaults to true

valueDelimiter

private char valueDelimiter
the value delimiter. Defaults to "

Constructor Details

CSVConfig

public CSVConfig()

Method Details

addField

public void addField(CSVField field)

equals

public boolean equals(Object obj)
TODO..
See Also:
java.lang.Object.equals(java.lang.Object)

getDelimiter

public char getDelimiter()
Returns:
the delimeter used.

getField

public CSVField getField(String name)

getFields

public CSVField[] getFields()
Returns:
an array with the known fields (even if no fields are specified)

getFill

public int getFill()
Returns:
the fill pattern.

getFillChar

public char getFillChar()
Returns:
the fillchar. Defaults to a space.

getValueDelimiter

public char getValueDelimiter()
Returns:
the value delimeter used. Defaults to "

guessConfig

public static CSVConfig guessConfig(InputStream inputStream)
Creates a config based on a stream. It tries to guess
NOTE : The stream will be closed.
Parameters:
inputStream - the inputstream.
Returns:
the guessed config.

isDelimiterIgnored

public boolean isDelimiterIgnored()
Returns:
if the writer should ignore the delimiter character.

isEndTrimmed

public boolean isEndTrimmed()
Returns:
if the end of the line should be trimmed. Default is false.

isFieldHeader

public boolean isFieldHeader()
Returns:
if a field header is used. Defaults to false

isFixedWidth

public boolean isFixedWidth()
Returns:
if the CSV file is fixedWidth

isValueDelimiterIgnored

public boolean isValueDelimiterIgnored()
Returns:
if the writer should ignore the value delimiter character. Defaults to true.

setDelimiter

public void setDelimiter(char delimiter)
Set the delimiter to use
Parameters:
delimiter - the delimiter character.

setEndTrimmed

public void setEndTrimmed(boolean endTrimmed)
Specify if the end of the line needs to be trimmed. Defaults to false.
Parameters:
endTrimmed -

setFieldHeader

public void setFieldHeader(boolean fieldHeader)
Specify if you want to use a field header.
Parameters:
fieldHeader - true or false.

setFields

public void setFields(Collection csvField)
Set the fields that should be used by the writer
Parameters:
csvField - a collection with fields. If null it will do nothing

setFields

public void setFields(CSVField[] csvFields)
Set the fields that should be used by the writer. This will overwrite currently added fields completely!
Parameters:
csvFields - the csvfields array. If null it will do nothing

setFill

public void setFill(int fill)
Parameters:
fill - the fill pattern.

setFillChar

public void setFillChar(char fillChar)
Set the fill char
Parameters:
fillChar - the fill char

setFixedWidth

public void setFixedWidth(boolean fixedWidth)
Specify if the CSV file is fixed width. Defaults to false
Parameters:
fixedWidth - the fixedwidth

setIgnoreDelimiter

public void setIgnoreDelimiter(boolean ignoreDelimiter)
Specify if the writer should ignore the delimiter.
Parameters:
ignoreDelimiter - defaults to false.

setIgnoreValueDelimiter

public void setIgnoreValueDelimiter(boolean ignoreValueDelimiter)
Specify if the writer should ignore the value delimiter.
Parameters:
ignoreValueDelimiter - defaults to false.

setValueDelimiter

public void setValueDelimiter(char valueDelimiter)
Set the value delimiter to use
Parameters:
valueDelimiter - the value delimiter character.