com.opencsv

Class CSVWriter

java.lang.Object

com.opencsv.CSVWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class CSVWriter
extends Object
implements Closeable, Flushable

A very simple CSV writer released under a commercial-friendly license.

Author:

Glen Smith

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_ESCAPE_CHARACTER The character used for escaping quotes.
static String	DEFAULT_LINE_END Default line terminator.
static char	DEFAULT_QUOTE_CHARACTER The default quote character to use if none is supplied to the constructor.
static char	DEFAULT_SEPARATOR The default separator to use if none is supplied to the constructor.
protected char	escapechar
protected IOException	exception
static int	INITIAL_STRING_SIZE
protected String	lineEnd
static char	NO_ESCAPE_CHARACTER The escape constant to use when you wish to suppress all escaping.
static char	NO_QUOTE_CHARACTER The quote constant to use when you wish to suppress all quoting.
protected char	quotechar
protected ResultSetHelper	resultService
static String	RFC4180_LINE_END RFC 4180 compliant line terminator.
protected char	separator
protected Writer	writer

Constructor Summary

Constructors

Constructor and Description
CSVWriter(Writer writer) Constructs CSVWriter using a comma for the separator.
CSVWriter(Writer writer, char separator) Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.
CSVWriter(Writer writer, char separator, char quotechar) Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.
CSVWriter(Writer writer, char separator, char quotechar, char escapechar) Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.
CSVWriter(Writer writer, char separator, char quotechar, char escapechar, String lineEnd) Constructs CSVWriter with supplied separator, quote char, escape char and line ending.
CSVWriter(Writer writer, char separator, char quotechar, String lineEnd) Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkCharactersToEscape(char nextChar) Checks whether the next character that is to be written out is a special character that must be quoted.
boolean	checkError() Flushes the buffer and checks to see if the there has been an error in the printstream.
void	close() Close the underlying stream writer flushing any buffered content.
void	flush() Flush underlying stream to writer.
void	flushQuietly() Flushes the writer without throwing any exceptions.
protected void	processCharacter(Appendable appendable, char nextChar) Appends the character to the StringBuilder adding the escape character if needed.
protected void	processLine(String nextElement, Appendable appendable) Processes all the characters in a line.
protected ResultSetHelper	resultService() Lazy resultSetHelper creation.
void	setResultService(ResultSetHelper resultService) Sets the result service.
protected boolean	stringContainsSpecialCharacters(String line) Checks to see if the line contains special characters.
void	writeAll(Iterable<String[]> allLines) Writes iterable to a CSV file.
void	writeAll(Iterable<String[]> allLines, boolean applyQuotesToAll) Writes iterable to a CSV file.
void	writeAll(List<String[]> allLines) Writes the entire list to a CSV file.
void	writeAll(List<String[]> allLines, boolean applyQuotesToAll) Writes the entire list to a CSV file.
int	writeAll(ResultSet rs, boolean includeColumnNames) Writes the entire ResultSet to a CSV file.
int	writeAll(ResultSet rs, boolean includeColumnNames, boolean trim) Writes the entire ResultSet to a CSV file.
int	writeAll(ResultSet rs, boolean includeColumnNames, boolean trim, boolean applyQuotesToAll) Writes the entire ResultSet to a CSV file.
protected void	writeColumnNames(ResultSet rs, boolean applyQuotesToAll) Writes the column names.
void	writeNext(String[] nextLine) Writes the next line to the file.
void	writeNext(String[] nextLine, boolean applyQuotesToAll) Writes the next line to the file.
protected void	writeNext(String[] nextLine, boolean applyQuotesToAll, Appendable appendable) Writes the next line to the file.

Methods inherited from class java.lang.Object

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

Field Detail

INITIAL_STRING_SIZE

public static final int INITIAL_STRING_SIZE

See Also:

Constant Field Values

DEFAULT_ESCAPE_CHARACTER

public static final char DEFAULT_ESCAPE_CHARACTER

The character used for escaping quotes.

See Also:

Constant Field Values

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

The default separator to use if none is supplied to the constructor.

See Also:

Constant Field Values

DEFAULT_QUOTE_CHARACTER

public static final char DEFAULT_QUOTE_CHARACTER

The default quote character to use if none is supplied to the constructor.

See Also:

Constant Field Values

NO_QUOTE_CHARACTER

public static final char NO_QUOTE_CHARACTER

The quote constant to use when you wish to suppress all quoting.

See Also:

Constant Field Values

NO_ESCAPE_CHARACTER

public static final char NO_ESCAPE_CHARACTER

The escape constant to use when you wish to suppress all escaping.

See Also:

Constant Field Values

DEFAULT_LINE_END

public static final String DEFAULT_LINE_END

Default line terminator.

See Also:

Constant Field Values

RFC4180_LINE_END

public static final String RFC4180_LINE_END

RFC 4180 compliant line terminator.

See Also:

Constant Field Values

writer

protected final Writer writer

separator

protected final char separator

quotechar

protected final char quotechar

escapechar

protected final char escapechar

lineEnd

protected String lineEnd

resultService

protected ResultSetHelper resultService

exception

protected volatile IOException exception

Constructor Detail

CSVWriter

public CSVWriter(Writer writer)

Constructs CSVWriter using a comma for the separator.

Parameters:

writer - The writer to an underlying CSV source.

CSVWriter

@Deprecated
public CSVWriter(Writer writer,
                    char separator)

Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.

Constructs CSVWriter with supplied separator.

Parameters:

writer - The writer to an underlying CSV source.

separator - The delimiter to use for separating entries.

CSVWriter

@Deprecated
public CSVWriter(Writer writer,
                    char separator,
                    char quotechar)

Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.

Constructs CSVWriter with supplied separator and quote char.

Parameters:

writer - The writer to an underlying CSV source.

separator - The delimiter to use for separating entries

quotechar - The character to use for quoted elements

CSVWriter

@Deprecated
public CSVWriter(Writer writer,
                    char separator,
                    char quotechar,
                    char escapechar)

Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.

Constructs CSVWriter with supplied separator and quote char.

Parameters:

writer - The writer to an underlying CSV source.

separator - The delimiter to use for separating entries

quotechar - The character to use for quoted elements

escapechar - The character to use for escaping quotechars or escapechars

CSVWriter

@Deprecated
public CSVWriter(Writer writer,
                    char separator,
                    char quotechar,
                    String lineEnd)

Deprecated. Please use CSVWriter(java.io.Writer, char, char, char, java.lang.String) instead.

Constructs CSVWriter with supplied separator and quote char.

Parameters:

writer - The writer to an underlying CSV source.

separator - The delimiter to use for separating entries

quotechar - The character to use for quoted elements

lineEnd - The line feed terminator to use

CSVWriter

public CSVWriter(Writer writer,
         char separator,
         char quotechar,
         char escapechar,
         String lineEnd)

Constructs CSVWriter with supplied separator, quote char, escape char and line ending.

Parameters:

writer - The writer to an underlying CSV source.

separator - The delimiter to use for separating entries

quotechar - The character to use for quoted elements

escapechar - The character to use for escaping quotechars or escapechars

lineEnd - The line feed terminator to use

Method Detail

writeAll

public void writeAll(Iterable<String[]> allLines,
            boolean applyQuotesToAll)

Writes iterable to a CSV file. The list is assumed to be a String[]

Parameters:

allLines - an Iterable of String[], with each String[] representing a line of the file.

applyQuotesToAll - true if all values are to be quoted. false if quotes only to be applied to values which contain the separator, escape, quote or new line characters.

writeAll

public void writeAll(List<String[]> allLines,
            boolean applyQuotesToAll)

Writes the entire list to a CSV file. The list is assumed to be a String[].

Parameters:

allLines - A List of String[] with each String[] representing a line of the file.

applyQuotesToAll - True if all values are to be quoted. False if quotes only to be applied to values which contain the separator, escape, quote, or new line characters.

writeAll

public void writeAll(Iterable<String[]> allLines)

Writes iterable to a CSV file. The list is assumed to be a String[]

Parameters:

allLines - an Iterable of String[], with each String[] representing a line of the file.

writeAll

public void writeAll(List<String[]> allLines)

Writes the entire list to a CSV file. The list is assumed to be a String[].

Parameters:

allLines - A List of String[] with each String[] representing a line of the file.

writeColumnNames

protected void writeColumnNames(ResultSet rs,
                    boolean applyQuotesToAll)
                         throws SQLException

Writes the column names.

Parameters:

rs - ResultSet containing column names.

applyQuotesToAll - Whether all header names should be quoted.

Throws:

SQLException - Thrown by ResultSetHelper.getColumnNames(java.sql.ResultSet)

writeAll

public int writeAll(ResultSet rs,
           boolean includeColumnNames)
             throws SQLException,
                    IOException

Writes the entire ResultSet to a CSV file. The caller is responsible for closing the ResultSet. Values are not trimmed. Quotes are applied to all values in the output.

Parameters:

rs - The result set to write

includeColumnNames - True if you want column names in the output, false otherwise

Returns:

Number of lines written.

Throws:

IOException - Thrown by ResultSetHelper.getColumnValues()

SQLException - Thrown by ResultSetHelper.getColumnValues()

writeAll

public int writeAll(ResultSet rs,
           boolean includeColumnNames,
           boolean trim)
             throws SQLException,
                    IOException

Writes the entire ResultSet to a CSV file. The caller is responsible for closing the ResultSet. Quotes are applied to all values in the output.

Parameters:

rs - The Result set to write.

includeColumnNames - Include the column names in the output.

trim - Remove spaces from the data before writing.

Returns:

Number of lines written - including header.

Throws:

IOException - Thrown by ResultSetHelper.getColumnValues()

SQLException - Thrown by ResultSetHelper.getColumnValues()

writeAll

public int writeAll(ResultSet rs,
           boolean includeColumnNames,
           boolean trim,
           boolean applyQuotesToAll)
             throws SQLException,
                    IOException

Writes the entire ResultSet to a CSV file. The caller is responsible for closing the ResultSet.

Parameters:

rs - The Result set to write.

includeColumnNames - Include the column names in the output.

trim - Remove spaces from the data before writing.

applyQuotesToAll - Whether all values should be quoted.

Returns:

Number of lines written - including header.

Throws:

IOException - Thrown by ResultSetHelper.getColumnValues()

SQLException - Thrown by ResultSetHelper.getColumnValues()

writeNext

public void writeNext(String[] nextLine,
             boolean applyQuotesToAll)

Writes the next line to the file.

Parameters:

nextLine - A string array with each comma-separated element as a separate entry.

applyQuotesToAll - True if all values are to be quoted. False applies quotes only to values which contain the separator, escape, quote, or new line characters.

writeNext

protected void writeNext(String[] nextLine,
             boolean applyQuotesToAll,
             Appendable appendable)
                  throws IOException

Writes the next line to the file. This method is a fail-fast method that will throw the IOException of the writer supplied to the CSVWriter (if the Writer does not handle the exceptions itself like the PrintWriter class).

Parameters:

nextLine - a string array with each comma-separated element as a separate entry.

applyQuotesToAll - true if all values are to be quoted. false applies quotes only to values which contain the separator, escape, quote or new line characters.

appendable - Appendable used as buffer.

Throws:

IOException - Exceptions thrown by the writer supplied to CSVWriter.

writeNext

public void writeNext(String[] nextLine)

Writes the next line to the file.

Parameters:

nextLine - A string array with each comma-separated element as a separate entry.

stringContainsSpecialCharacters

protected boolean stringContainsSpecialCharacters(String line)

Checks to see if the line contains special characters.

Parameters:

line - Element of data to check for special characters.

Returns:

True if the line contains the quote, escape, separator, newline, or return.

processLine

protected void processLine(String nextElement,
               Appendable appendable)
                    throws IOException

Processes all the characters in a line.

Parameters:

nextElement - Element to process.

appendable - - Appendable holding the processed data.

Throws:

IOException - - IOException thrown by the writer supplied to the CSVWriter

processCharacter

protected void processCharacter(Appendable appendable,
                    char nextChar)
                         throws IOException

Appends the character to the StringBuilder adding the escape character if needed.

Parameters:

appendable - - Appendable holding the processed data.

nextChar - Character to process

Throws:

IOException - - IOException thrown by the writer supplied to the CSVWriter.

checkCharactersToEscape

protected boolean checkCharactersToEscape(char nextChar)

Checks whether the next character that is to be written out is a special character that must be quoted. The quote character, escape charater, and separator are special characters.

Parameters:

nextChar - The next character to be written

Returns:

Whether the character needs to be quoted or not

flush

public void flush()
           throws IOException

Flush underlying stream to writer.

Specified by:

flush in interface Flushable

Throws:

IOException - If bad things happen

close

public void close()
           throws IOException

Close the underlying stream writer flushing any buffered content.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - If bad things happen

checkError

public boolean checkError()

Flushes the buffer and checks to see if the there has been an error in the printstream.

Returns:

True if the print stream has encountered an error either on the underlying output stream or during a format conversion.

setResultService

public void setResultService(ResultSetHelper resultService)

Sets the result service.

Parameters:

resultService - The ResultSetHelper

resultService

protected ResultSetHelper resultService()

Lazy resultSetHelper creation.

Returns:

Instance of resultSetHelper

flushQuietly

public void flushQuietly()

Flushes the writer without throwing any exceptions.