org.jfree.report.util

Class CSVQuoter

public class CSVQuoter extends Object

The CSVQuoter is a helper class to encode a string for the CSV file format.

Author: Thomas Morgner.

Constructor Summary
	CSVQuoter() Creates a new CSVQuoter, which uses a comma as the default separator.
	CSVQuoter(char separator) Creates a new `CSVQuoter`, which uses the defined separator.
	CSVQuoter(char separator, char quate) Creates a new CSVQuoter with the given separator and quoting character.

Method Summary
String	doQuoting(String original) Encodes the string, so that the string can safely be used in CSV files.
char	getQuate() Returns the quoting character.
char	getSeparator() Gets the separator used in this quoter and the CSV file.
String	undoQuoting(String nativeString) Decodes the string, so that all escape sequences get removed.

Constructor Detail

CSVQuoter

public CSVQuoter()

Creates a new CSVQuoter, which uses a comma as the default separator.

CSVQuoter

public CSVQuoter(char separator)

Creates a new CSVQuoter, which uses the defined separator.

Parameters: separator the separator.

Throws: NullPointerException if the given separator is null.

CSVQuoter

public CSVQuoter(char separator, char quate)

Creates a new CSVQuoter with the given separator and quoting character.

Parameters: separator the separator quate the quoting character

Method Detail

doQuoting

public String doQuoting(String original)

Encodes the string, so that the string can safely be used in CSV files. If the string does not need quoting, the original string is returned unchanged.

Parameters: original the unquoted string.

Returns: The quoted string

getQuate

public char getQuate()

Returns the quoting character.

Returns: the quote character.

getSeparator

public char getSeparator()

Gets the separator used in this quoter and the CSV file.

Returns: the separator (never null).

undoQuoting

public String undoQuoting(String nativeString)

Decodes the string, so that all escape sequences get removed. If the string was not quoted, then the string is returned unchanged.

Parameters: nativeString the quoted string.

Returns: The unquoted string.