public class CSVWriter
extends java.lang.Object
implements java.io.Closeable, java.io.Flushable
Modifier and Type | Field and Description |
---|---|
static char |
DEFAULT_ESCAPE_CHARACTER
The character used for escaping quotes.
|
static java.lang.String |
DEFAULT_LINE_END
Default line terminator uses platform encoding.
|
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.
|
static int |
INITIAL_STRING_SIZE |
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.
|
Constructor and Description |
---|
CSVWriter(java.io.Writer writer)
Constructs CSVWriter using a comma for the separator.
|
CSVWriter(java.io.Writer writer,
char separator)
Constructs CSVWriter with supplied separator.
|
CSVWriter(java.io.Writer writer,
char separator,
char quotechar)
Constructs CSVWriter with supplied separator and quote char.
|
CSVWriter(java.io.Writer writer,
char separator,
char quotechar,
char escapechar)
Constructs CSVWriter with supplied separator and quote char.
|
CSVWriter(java.io.Writer writer,
char separator,
char quotechar,
char escapechar,
java.lang.String lineEnd)
Constructs CSVWriter with supplied separator, quote char, escape char and line ending.
|
CSVWriter(java.io.Writer writer,
char separator,
char quotechar,
java.lang.String lineEnd)
Constructs CSVWriter with supplied separator and quote char.
|
Modifier and Type | Method and Description |
---|---|
boolean |
checkError()
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() |
void |
setResultService(ResultSetHelper resultService) |
void |
writeAll(java.util.List<java.lang.String[]> allLines)
Writes the entire list to a CSV file.
|
void |
writeAll(java.util.List<java.lang.String[]> allLines,
boolean applyQuotesToAll)
Writes the entire list to a CSV file.
|
void |
writeAll(java.sql.ResultSet rs,
boolean includeColumnNames)
Writes the entire ResultSet to a CSV file.
|
void |
writeAll(java.sql.ResultSet rs,
boolean includeColumnNames,
boolean trim)
Writes the entire ResultSet to a CSV file.
|
void |
writeNext(java.lang.String[] nextLine)
Writes the next line to the file.
|
void |
writeNext(java.lang.String[] nextLine,
boolean applyQuotesToAll)
Writes the next line to the file.
|
public static final int INITIAL_STRING_SIZE
public static final char DEFAULT_ESCAPE_CHARACTER
public static final char DEFAULT_SEPARATOR
public static final char DEFAULT_QUOTE_CHARACTER
public static final char NO_QUOTE_CHARACTER
public static final char NO_ESCAPE_CHARACTER
public static final java.lang.String DEFAULT_LINE_END
public CSVWriter(java.io.Writer writer)
writer
- the writer to an underlying CSV source.public CSVWriter(java.io.Writer writer, char separator)
writer
- the writer to an underlying CSV source.separator
- the delimiter to use for separating entries.public CSVWriter(java.io.Writer writer, char separator, char quotechar)
writer
- the writer to an underlying CSV source.separator
- the delimiter to use for separating entriesquotechar
- the character to use for quoted elementspublic CSVWriter(java.io.Writer writer, char separator, char quotechar, char escapechar)
writer
- the writer to an underlying CSV source.separator
- the delimiter to use for separating entriesquotechar
- the character to use for quoted elementsescapechar
- the character to use for escaping quotechars or escapecharspublic CSVWriter(java.io.Writer writer, char separator, char quotechar, java.lang.String lineEnd)
writer
- the writer to an underlying CSV source.separator
- the delimiter to use for separating entriesquotechar
- the character to use for quoted elementslineEnd
- the line feed terminator to usepublic CSVWriter(java.io.Writer writer, char separator, char quotechar, char escapechar, java.lang.String lineEnd)
writer
- the writer to an underlying CSV source.separator
- the delimiter to use for separating entriesquotechar
- the character to use for quoted elementsescapechar
- the character to use for escaping quotechars or escapecharslineEnd
- the line feed terminator to usepublic void writeAll(java.util.List<java.lang.String[]> allLines, boolean applyQuotesToAll)
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.public void writeAll(java.util.List<java.lang.String[]> allLines)
allLines
- a List of String[], with each String[] representing a line of
the file.public void writeAll(java.sql.ResultSet rs, boolean includeColumnNames) throws java.sql.SQLException, java.io.IOException
rs
- the recordset to writeincludeColumnNames
- true if you want column names in the output, false otherwisejava.io.IOException
- thrown by getColumnValuejava.sql.SQLException
- thrown by getColumnValuepublic void writeAll(java.sql.ResultSet rs, boolean includeColumnNames, boolean trim) throws java.sql.SQLException, java.io.IOException
java.io.IOException
- thrown by getColumnValuejava.sql.SQLException
- thrown by getColumnValuepublic void writeNext(java.lang.String[] nextLine, boolean applyQuotesToAll)
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.public void writeNext(java.lang.String[] nextLine)
nextLine
- a string array with each comma-separated element as a separate
entry.public void flush() throws java.io.IOException
flush
in interface java.io.Flushable
java.io.IOException
- if bad things happenpublic void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
java.io.IOException
- if bad things happenpublic boolean checkError()
public void setResultService(ResultSetHelper resultService)
public void flushQuietly()