CSV (opencsv 2.4 API)

java.lang.Object
- au.com.bytecode.opencsv.CSV

public class CSV
extends Object

A very simple CSV format container. It allows to construct CSVReader and CSVWriter objects. Also it provides helper methods to read and write CSV. Example:

 // define CSV format 
    CSV csv = CSV
          .separator(',')
          .skipLines(1)
          .create();
		
    // write CSV file
    csv.write("example.csv", new CSVWriteProc() {
        public void process(CSVWriter out) {
            out.writeNext("Col1", "Col2");
            out.writeNext("Val1", "Val2");
        }
    });
		
    // read CSV file
    csv.read("example.csv", new CSVReadProc() {
        public void procRow(int rowIndex, String... values) {
            System.out.println(Arrays.asList(values));
        }
    });

Author:: Dmitry Sanatin

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CSV.Builder
A builder for creating CSV formats.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CSV.Builder` A builder for creating CSV formats.

Method Summary

Methods
Modifier and Type	Method and Description
`static CSV.Builder`	`charset(Charset charset)` Constructs `CSVBuilder` with specified charset
`static CSV.Builder`	`charset(String charsetName)` Constructs `CSVBuilder` with specified charset
`static CSV`	`create()` Constructs `CSV` using default separator, quote char, etc.
`static CSV.Builder`	`escape(char escapeChar)` Constructs `CSVBuilder` with specified escapeChar
`static CSV.Builder`	`ignoreLeadingWhiteSpace()` Constructs `CSVBuilder`.
`static CSV.Builder`	`lineEnd(String lineEnd)` Constructs `CSVBuilder` with specified line terminator
`static CSV.Builder`	`noEscape()` Constructs `CSVBuilder` with no escape char
`static CSV.Builder`	`noQuote()` Constructs `CSVBuilder` with no quote char
`static CSV.Builder`	`notIgnoreLeadingWhiteSpace()` Constructs `CSVBuilder`.
`static CSV.Builder`	`notStrictQuotes()` Constructs `CSVBuilder`.
`static CSV.Builder`	`quote(char quoteChar)` Constructs `CSVBuilder` with specified quoteChar
`void`	`read(CSVReader reader, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`read(File file, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`read(InputStream is, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`read(Reader reader, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`read(String fileName, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`readAndClose(CSVReader reader, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`readAndClose(InputStream is, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`void`	`readAndClose(Reader reader, CSVReadProc proc)` Read CSV using the supplied `CSVReadProc`.
`CSVReader`	`reader(File file)` Constructs `CSVReader` using configured CSV format.
`CSVReader`	`reader(InputStream is)` Constructs `CSVReader` using configured CSV format.
`CSVReader`	`reader(Reader reader)` Constructs `CSVReader` using configured CSV format.
`CSVReader`	`reader(String fileName)` Constructs `CSVReader` using configured CSV format.
`static CSV.Builder`	`separator(char separator)` Constructs `CSVBuilder` with specified separator
`static CSV.Builder`	`skipLines(int skipLines)` Constructs `CSVBuilder` with specified number of lines to skip for start reading
`static CSV.Builder`	`strictQuotes()` Constructs `CSVBuilder`.
`void`	`write(CSVWriter writer, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`write(File file, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`write(OutputStream os, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`write(String fileName, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`write(Writer writer, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`writeAndClose(CSVWriter writer, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`writeAndClose(OutputStream os, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`void`	`writeAndClose(Writer writer, CSVWriteProc proc)` Write CSV using the supplied `CSVWriteProc`.
`CSVWriter`	`writer(File file)` Constructs `CSVWriter` using configured CSV file format.
`CSVWriter`	`writer(OutputStream os)` Constructs `CSVWriter` using configured CSV file format.
`CSVWriter`	`writer(String fileName)` Constructs `CSVWriter` using configured CSV file format.
`CSVWriter`	`writer(Writer writer)` Constructs `CSVWriter` using configured CSV format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - writer
```
public CSVWriter writer(Writer writer)
```
    Constructs CSVWriter using configured CSV format.
    
    Parameters:
    writer - the writer to an underlying CSV.
  - writer
```
public CSVWriter writer(OutputStream os)
```
    Constructs CSVWriter using configured CSV file format.
    
    Parameters:
    os - the output stream to an underlying CSV.
  - writer
```
public CSVWriter writer(File file)
```
    Constructs CSVWriter using configured CSV file format.
    
    Parameters:
    file - CSV file
  - writer
```
public CSVWriter writer(String fileName)
```
    Constructs CSVWriter using configured CSV file format.
    
    Parameters:
    fileName - name of CSV file
  - write
```
public void write(Writer writer,
         CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    writer - the writer to an underlying CSV. The writer will not be closed.
    proc - the CSVWriteProc to use for CSV writing
  - write
```
public void write(OutputStream os,
         CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    os - the output stream to an underlying CSV. The output stream will not be closed.
    proc - the CSVWriteProc to use for CSV writing
  - write
```
public void write(String fileName,
         CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    fileName - the name of CSV file
    proc - the CSVWriteProc to use for CSV writing
  - write
```
public void write(CSVWriter writer,
         CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    writer - the writer to an underlying CSV. The writer will not be closed.
    proc - the CSVWriteProc to use for CSV writing
  - write
```
public void write(File file,
         CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    file - CSV file
    proc - the CSVWriteProc to use for CSV writing
  - writeAndClose
```
public void writeAndClose(Writer writer,
                 CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    writer - the writer to an underlying CSV. The writer will be closed.
    proc - the CSVWriteProc to use for CSV writing
  - writeAndClose
```
public void writeAndClose(OutputStream os,
                 CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    os - the output stream to an underlying CSV. The output stream will be closed.
    proc - the CSVWriteProc to use for CSV writing
  - writeAndClose
```
public void writeAndClose(CSVWriter writer,
                 CSVWriteProc proc)
```
    Write CSV using the supplied CSVWriteProc.
    
    Parameters:
    writer - the writer to an underlying CSV. The writer will be closed.
    proc - the CSVWriteProc to use for CSV writing
  - reader
```
public CSVReader reader(Reader reader)
```
    Constructs CSVReader using configured CSV format.
    
    Parameters:
    reader - the reader of an underlying CSV.
  - reader
```
public CSVReader reader(InputStream is)
```
    Constructs CSVReader using configured CSV format.
    
    Parameters:
    is - the input stream of an underlying CSV.
  - reader
```
public CSVReader reader(File file)
```
    Constructs CSVReader using configured CSV format.
    
    Parameters:
    file - the CSV file
  - reader
```
public CSVReader reader(String fileName)
```
    Constructs CSVReader using configured CSV format.
    
    Parameters:
    fileName - the file name.
  - read
```
public void read(InputStream is,
        CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    is - the input stream of an underlying CSV. The input stream will not be closed.
    proc - the CSVReadProc to use for CSV reading
  - read
```
public void read(Reader reader,
        CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    reader - the reader of an underlying CSV. The reader will not be closed.
    proc - the CSVReadProc to use for CSV reading
  - read
```
public void read(File file,
        CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    file - CSV file
    proc - the CSVReadProc to use for CSV reading
  - read
```
public void read(String fileName,
        CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    fileName - the file name
    proc - the CSVReadProc to use for CSV reading
  - read
```
public void read(CSVReader reader,
        CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    reader - the reader of an underlying CSV. The reader will not be closed.
    proc - the CSVReadProc to use for CSV reading
  - readAndClose
```
public void readAndClose(InputStream is,
                CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    is - the input stream of an underlying CSV. The input stream will be closed.
    proc - the CSVReadProc to use for CSV reading
  - readAndClose
```
public void readAndClose(Reader reader,
                CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    reader - the reader of an underlying CSV. The reader will be closed.
    proc - the CSVReadProc to use for CSV reading
  - readAndClose
```
public void readAndClose(CSVReader reader,
                CSVReadProc proc)
```
    Read CSV using the supplied CSVReadProc.
    
    Parameters:
    reader - the reader of an underlying CSV. The reader will be closed.
    proc - the CSVReadProc to use for CSV reading
  - create
```
public static CSV create()
```
    Constructs CSV using default separator, quote char, etc.
  - separator
```
public static CSV.Builder separator(char separator)
```
    Constructs CSVBuilder with specified separator
    
    Parameters:
    separator - the delimiter to use for separating entries
  - quote
```
public static CSV.Builder quote(char quoteChar)
```
    Constructs CSVBuilder with specified quoteChar
    
    Parameters:
    quoteChar - the character to use for quoted elements
  - noQuote
```
public static CSV.Builder noQuote()
```
    Constructs CSVBuilder with no quote char
  - escape
```
public static CSV.Builder escape(char escapeChar)
```
    Constructs CSVBuilder with specified escapeChar
    
    Parameters:
    escapeChar - the character to use for escaping quotechars or escapechars
  - noEscape
```
public static CSV.Builder noEscape()
```
    Constructs CSVBuilder with no escape char
  - lineEnd
```
public static CSV.Builder lineEnd(String lineEnd)
```
    Constructs CSVBuilder with specified line terminator
    
    Parameters:
    lineEnd - the line feed terminator to use
  - skipLines
```
public static CSV.Builder skipLines(int skipLines)
```
    Constructs CSVBuilder with specified number of lines to skip for start reading
    
    Parameters:
    skipLines - the line number to skip for start reading
  - strictQuotes
```
public static CSV.Builder strictQuotes()
```
    Constructs CSVBuilder. Characters outside the quotes will be ignored.
  - notStrictQuotes
```
public static CSV.Builder notStrictQuotes()
```
    Constructs CSVBuilder. Characters outside the quotes will not be ignored.
  - ignoreLeadingWhiteSpace
```
public static CSV.Builder ignoreLeadingWhiteSpace()
```
    Constructs CSVBuilder. White space before a quote in a field will be ignored.
  - notIgnoreLeadingWhiteSpace
```
public static CSV.Builder notIgnoreLeadingWhiteSpace()
```
    Constructs CSVBuilder. White space before a quote in a field will not be ignored.
  - charset
```
public static CSV.Builder charset(Charset charset)
```
    Constructs CSVBuilder with specified charset
  - charset
```
public static CSV.Builder charset(String charsetName)
```
    Constructs CSVBuilder with specified charset

Class CSV

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

writer

writer

writer

writer

write

write

write

write

write

writeAndClose

writeAndClose

writeAndClose

reader

reader

reader

reader

read

read

read

read

read

readAndClose

readAndClose

readAndClose

create

separator

quote

noQuote

escape

noEscape

lineEnd

skipLines

strictQuotes

notStrictQuotes

ignoreLeadingWhiteSpace

notIgnoreLeadingWhiteSpace

charset

charset