com.smoothcsv.core.macro.api

Class CsvProperties

java.lang.Object

com.smoothcsv.core.macro.apiimpl.APIBase

com.smoothcsv.core.macro.api.CsvProperties

public class CsvProperties
extends com.smoothcsv.core.macro.apiimpl.APIBase

A class representing CSV properties such as delimiter, quote, and so on.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO
static java.lang.String	CR
static java.lang.String	CRLF
static java.lang.String	LF
static int	NO_QUOTE Suppresses all quoting.
static int	QUOTES_ALL Quotes all values.
static int	QUOTES_IF_NECESSARY Quotes only when the value contains delimiter, quote, or escape.

Constructor Summary

Constructors

Constructor and Description
CsvProperties() Creates CsvProperties.

Method Summary

Modifier and Type	Method and Description
static CsvProperties	defaultProperties() Creates default CsvProperties.
java.lang.String	getCharset() Returns the charset that is used for saving file.
java.lang.String	getDelimiter() Returns the character to separate each field.
java.lang.String	getEscape() Returns the character to escape quote characters.
java.lang.String	getNewlineCharacter() Returns the newline character that is used for saving file.
java.lang.String	getQuote() Returns the character to quote a field.
int	getQuoteOption() Returns the rule which indicates how to apply quote to a value.
boolean	hasBOM() Returns if the BOM (Byte Order Mark) will be inserted.
void	setCharset(java.lang.String charset) Sets the charset that is used for saving file.
void	setDelimiter(java.lang.String delimiter) Sets the character to separate each field.
void	setEscape(java.lang.String escape) Sets the character to escape quote characters.
void	setHasBOM(boolean hasBOM) Sets if the BOM (Byte Order Mark) will be inserted.
void	setNewlineCharacter(java.lang.String newlineCharacter) Sets the newline character that is used for saving file.
void	setQuote(java.lang.String quote) Sets the character to quote a field.
void	setQuoteOption(int quoteOption) Sets the rule which indicates how to apply quote to a value.

Methods inherited from class com.smoothcsv.core.macro.apiimpl.APIBase

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTO

public static final java.lang.String AUTO

See Also:

Constant Field Values

NO_QUOTE

public static final int NO_QUOTE

Suppresses all quoting.

See Also:

Constant Field Values

QUOTES_ALL

public static final int QUOTES_ALL

Quotes all values.

See Also:

Constant Field Values

QUOTES_IF_NECESSARY

public static final int QUOTES_IF_NECESSARY

Quotes only when the value contains delimiter, quote, or escape.

See Also:

Constant Field Values

CR

public static final java.lang.String CR

LF

public static final java.lang.String LF

CRLF

public static final java.lang.String CRLF

Constructor Detail

CsvProperties

public CsvProperties()

Creates CsvProperties.

Method Detail

defaultProperties

public static CsvProperties defaultProperties()

Creates default CsvProperties.

Returns:

CsvProperties

getDelimiter

public java.lang.String getDelimiter()

Returns the character to separate each field.

Returns:

the character to separate each field

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Sets the character to separate each field.

Parameters:

delimiter - the character to separate each field

getQuote

public java.lang.String getQuote()

Returns the character to quote a field.

Returns:

the character to quote a field

setQuote

public void setQuote(java.lang.String quote)

Sets the character to quote a field.

Parameters:

quote - the character to quote a field

getEscape

public java.lang.String getEscape()

Returns the character to escape quote characters. If this character equals '\0', quote characters must be represented by a pair of quote characters.

Returns:

the character to escape quote characters

setEscape

public void setEscape(java.lang.String escape)

Sets the character to escape quote characters. If this character equals '\0', quote characters must be represented by a pair of quote characters.

Parameters:

escape - the character to escape quote characters

getCharset

public java.lang.String getCharset()

Returns the charset that is used for saving file.

Returns:

the charset

setCharset

public void setCharset(java.lang.String charset)

Sets the charset that is used for saving file.

Parameters:

charset - the charset to set

setHasBOM

public void setHasBOM(boolean hasBOM)

Sets if the BOM (Byte Order Mark) will be inserted. If hasBOM is true and a UTF codec is used, the BOM (Byte Order Mark) will be inserted before any data has been written to the file.

Parameters:

hasBOM - true if the BOM (Byte Order Mark) will be inserted

hasBOM

public boolean hasBOM()

Returns if the BOM (Byte Order Mark) will be inserted. If hasBOM is true and a UTF codec is used, the BOM (Byte Order Mark) will be inserted before any data has been written to the file.

Returns:

true if the BOM (Byte Order Mark) will be inserted

getNewlineCharacter

public java.lang.String getNewlineCharacter()

Returns the newline character that is used for saving file.

Returns:

the newline character

setNewlineCharacter

public void setNewlineCharacter(java.lang.String newlineCharacter)

Sets the newline character that is used for saving file.

Parameters:

newlineCharacter - the newline character to set

getQuoteOption

public int getQuoteOption()

Returns the rule which indicates how to apply quote to a value. The value is either of the below.

• NO_QUOTE
• QUOTES_ALL
• QUOTES_IF_NECESSARY

Returns:

the quoteOption

setQuoteOption

public void setQuoteOption(int quoteOption)

Sets the rule which indicates how to apply quote to a value. The value must be either of the below.

• NO_QUOTE
• QUOTES_ALL
• QUOTES_IF_NECESSARY

Parameters:

quoteOption - the quoteOption to set