CSVWriter (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- util.opencsv.CSVWriter

```
public class CSVWriter
extends Object
```
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 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 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 Summary

Constructors
Constructor and Description
`CSVWriter(Writer writer)` Constructs CSVWriter using a comma for the separator.
`CSVWriter(Writer writer, char separator)` Constructs CSVWriter with supplied separator.
`CSVWriter(Writer writer, char separator, char quotechar)` Constructs CSVWriter with supplied separator and quote char.
`CSVWriter(Writer writer, char separator, char quotechar, char escapechar)` Constructs CSVWriter with supplied separator and quote char.
`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)` Constructs CSVWriter with supplied separator and quote char.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close the underlying stream writer flushing any buffered content.
`void`	`flush()` Flush underlying stream to writer.
`void`	`writeAll(List allLines)` Writes the entire list to a CSV file.
`void`	`writeAll(ResultSet rs, boolean includeColumnNames)` Writes the entire ResultSet to a CSV file.
`protected void`	`writeColumnNames(ResultSetMetaData metadata)`
`void`	`writeNext(String[] nextLine)` 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
  - 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 uses platform encoding.
    
    See Also:
    
    Constant Field Values
- 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
```
public CSVWriter(Writer writer,
                 char separator)
```
    Constructs CSVWriter with supplied separator.
    
    Parameters:
    
    writer - the writer to an underlying CSV source.
    
    separator - the delimiter to use for separating entries.
  - CSVWriter
```
public CSVWriter(Writer writer,
                 char separator,
                 char quotechar)
```
    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
```
public CSVWriter(Writer writer,
                 char separator,
                 char quotechar,
                 char escapechar)
```
    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
```
public CSVWriter(Writer writer,
                 char separator,
                 char quotechar,
                 String lineEnd)
```
    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(List 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(ResultSetMetaData metadata)
                         throws SQLException
```
    Throws:
    
    SQLException
  - writeAll
```
public void writeAll(ResultSet rs,
                     boolean includeColumnNames)
              throws SQLException,
                     IOException
```
    Writes the entire ResultSet to a CSV file. The caller is responsible for closing the ResultSet.
    
    Parameters:
    
    rs - the recordset to write
    
    includeColumnNames - true if you want column names in the output, false otherwise
    
    Throws:
    
    SQLException
    
    IOException
  - 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.
  - flush
```
public void flush()
           throws IOException
```
    Flush underlying stream to writer.
    
    Throws:
    
    IOException - if bad things happen
  - close
```
public void close()
           throws IOException
```
    Close the underlying stream writer flushing any buffered content.
    
    Throws:
    
    IOException - if bad things happen

Class CSVWriter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ESCAPE_CHARACTER

DEFAULT_SEPARATOR

DEFAULT_QUOTE_CHARACTER

NO_QUOTE_CHARACTER

NO_ESCAPE_CHARACTER

DEFAULT_LINE_END

Constructor Detail

CSVWriter

CSVWriter

CSVWriter

CSVWriter

CSVWriter

CSVWriter

Method Detail

writeAll

writeColumnNames

writeAll

writeNext

flush

close