Uses of Class org.apache.commons.csv.CSVParser (Apache Commons CSV 1.2 API)

Uses of CSVParser in org.apache.commons.csv

+ + + + + + + + + + + + + + + + + + + + + + + + +

Methods in org.apache.commons.csv that return CSVParser
Modifier and Type	Method and Description
`static CSVParser`	CSVParser.`parse(File file, + Charset charset, + CSVFormat format)` + Creates a parser for the given `File`. +
`CSVParser`	CSVFormat.`parse(Reader in)` + Parses the specified content. +
`static CSVParser`	CSVParser.`parse(String string, + CSVFormat format)` + Creates a parser for the given `String`. +
`static CSVParser`	CSVParser.`parse(URL url, + Charset charset, + CSVFormat format)` + Creates a parser for the given URL. +

Methods in org.apache.commons.csv that return CSVPrinter
Modifier and Type	Method and Description
`CSVPrinter`	CSVFormat.`print(Appendable out)` + Prints to the specified output. +

Methods in org.apache.commons.csv that return CSVPrinter

Modifier and Type

Method and Description

CSVPrinter

CSVFormat.print(Appendable out) +

Prints to the specified output.

+ + +

Uses of CSVRecord in org.apache.commons.csv

+ + + + + + + + + + + + + + + + +

Methods in org.apache.commons.csv that return types with arguments of type CSVRecord
Modifier and Type	Method and Description
`List<CSVRecord>`	CSVParser.`getRecords()` + Parses the CSV input according to the given format and returns the content as a list of + `CSVRecords`. +
`Iterator<CSVRecord>`	CSVParser.`iterator()` + Returns an iterator on the records. +

+ + +

Uses of QuoteMode in org.apache.commons.csv

+ + + + + + + + + + + + + + + + + + + + +

Methods in org.apache.commons.csv that return QuoteMode
Modifier and Type	Method and Description
`QuoteMode`	CSVFormat.`getQuoteMode()` + Returns the quote policy output fields. +
`static QuoteMode`	QuoteMode.`valueOf(String name)` + Returns the enum constant of this type with the specified name. +
`static QuoteMode[]`	QuoteMode.`values()` + Returns an array containing the constants of this enum type, in +the order they are declared. +

+ + + + + + + + + + + + +

Methods in org.apache.commons.csv with parameters of type QuoteMode
Modifier and Type	Method and Description
`CSVFormat`	CSVFormat.`withQuoteMode(QuoteMode quoteModePolicy)` + Sets the output quote policy of the format to the specified value. +

org.apache.commons.csv

+ + + + + + + + + + + + + + + + + + + + + + + + +

Class Summary
Class	Description
CSVFormat	+ Specifies the format of a CSV file and parses input. +
CSVParser	+ Parses CSV files according to the specified format. +
CSVPrinter	+ Prints values in a CSV format. +
CSVRecord	+ A CSV record parsed from a CSV file. +

+ + + + + + + + + + + + + + + + +
Enum Summary
Enum Description
CSVFormat.Predefined +
Predefines formats.
+
QuoteMode +
Defines quote behavior when printing.
+
+

Enum Summary
Enum	Description
CSVFormat.Predefined	+ Predefines formats. +
QuoteMode	+ Defines quote behavior when printing. +

+ + + +

Package org.apache.commons.csv Description

Apache Commons CSV Format Support. + +

CSV are widely used as interfaces to legacy systems or manual data-imports. + CSV stands for "Comma Separated Values" (or sometimes "Character Separated + Values"). The CSV data format is defined in + RFC 4180 + but many dialects exist.

+ +

Common to all file dialects is its basic structure: The CSV data-format + is record oriented, whereas each record starts on a new textual line. A + record is build of a list of values. Keep in mind that not all records + must have an equal number of values:

+       csv    := records*
+       record := values*
+

+ +

The following list contains the CSV aspects the Commons CSV parser supports:

Separators (for lines): The record separators are hardcoded and cannot be changed. The must be '\r', '\n' or '\r\n'.
Delimiter (for values): The delimiter for values is freely configurable (default ',').
Comments: Some CSV-dialects support a simple comment syntax. A comment is a record + which must start with a designated character (the commentStarter). A record + of this kind is treated as comment and gets removed from the input (default none)
Encapsulator: Two encapsulator characters (default '"') are used to enclose -> complex values.
Simple values: A simple value consist of all characters (except the delimiter) until + (but not including) the next delimiter or a record-terminator. Optionally + all surrounding whitespaces of a simple value can be ignored (default: true).
Complex values: Complex values are encapsulated within a pair of the defined encapsulator characters. + The encapsulator itself must be escaped or doubled when used inside complex values. + Complex values preserve all kind of formatting (including newlines -> multiline-values)
Empty line skipping: Optionally empty lines in CSV files can be skipped. + Otherwise, empty lines will return a record with a single empty value.

+ +

In addition to individually defined dialects, two predefined dialects (strict-csv, and excel-csv) + can be set directly.

+ +

Example usage:

+ Reader in = new StringReader("a,b,c");
+ for (CSVRecord record : CSVFormat.DEFAULT.parse(in)) {
+     for (String field : record) {
+         System.out.print("\"" + field + "\", ");
+     }
+     System.out.println();
+ }
+

Class Hierarchy

java.lang.Object +
- org.apache.commons.csv.CSVFormat (implements java.io.Serializable)
- org.apache.commons.csv.CSVParser (implements java.io.Closeable, java.lang.Iterable<T>)
- org.apache.commons.csv.CSVPrinter (implements java.io.Closeable, java.io.Flushable)
- org.apache.commons.csv.CSVRecord (implements java.lang.Iterable<T>, java.io.Serializable)
+

Enum Hierarchy

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
  - org.apache.commons.csv.QuoteMode
  - org.apache.commons.csv.CSVFormat.Predefined
  +
+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes in org.apache.commons.csv used by org.apache.commons.csv
Class and Description
CSVFormat + Specifies the format of a CSV file and parses input. +
CSVFormat.Predefined + Predefines formats. +
CSVParser + Parses CSV files according to the specified format. +
CSVPrinter + Prints values in a CSV format. +
CSVRecord + A CSV record parsed from a CSV file. +
QuoteMode + Defines quote behavior when printing. +

Class Hierarchy

java.lang.Object +
- org.apache.commons.csv.CSVFormat (implements java.io.Serializable)
- org.apache.commons.csv.CSVParser (implements java.io.Closeable, java.lang.Iterable<T>)
- org.apache.commons.csv.CSVPrinter (implements java.io.Closeable, java.io.Flushable)
- org.apache.commons.csv.CSVRecord (implements java.lang.Iterable<T>, java.io.Serializable)
+

Enum Hierarchy

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
  - org.apache.commons.csv.QuoteMode
  - org.apache.commons.csv.CSVFormat.Predefined
  +
+

+
Package org.apache.commons.csv
+
- + + +
  Class org.apache.commons.csv.CSVFormat extends Object implements Serializable
  +
  +
  serialVersionUID:
  +
  1L
  +
  +
  - +
    Serialized Fields
    +
    - +
      delimiter
      +
```
char delimiter
```
      +
    - +
      quoteCharacter
      +
```
Character quoteCharacter
```
      +
    - +
      quoteMode
      +
```
QuoteMode quoteMode
```
      +
    - +
      commentMarker
      +
```
Character commentMarker
```
      +
    - +
      escapeCharacter
      +
```
Character escapeCharacter
```
      +
    - +
      ignoreSurroundingSpaces
      +
```
boolean ignoreSurroundingSpaces
```
      +
    - +
      allowMissingColumnNames
      +
```
boolean allowMissingColumnNames
```
      +
    - +
      ignoreEmptyLines
      +
```
boolean ignoreEmptyLines
```
      +
    - +
      recordSeparator
      +
```
String recordSeparator
```
      +
    - +
      nullString
      +
```
String nullString
```
      +
    - +
      header
      +
```
String[] header
```
      +
    - +
      headerComments
      +
```
String[] headerComments
```
      +
    - +
      skipHeaderRecord
      +
```
boolean skipHeaderRecord
```
      +
    +
  +
- + + +
  Class org.apache.commons.csv.CSVRecord extends Object implements Serializable
  +
  +
  serialVersionUID:
  +
  1L
  +
  +
  - +
    Serialized Fields
    +
    - +
      characterPosition
      +
```
long characterPosition
```
      +
    - +
      comment
      +
```
String comment
```
      +
      The accumulated comments (if any)
      +
    - +
      mapping
      +
```
Map<K,V> mapping
```
      +
      The column name to index mapping.
      +
    - +
      recordNumber
      +
```
long recordNumber
```
      +
      The record number.
      +
    - +
      values
      +
```
String[] values
```
      +
      The values of the record
      +
    +
  +
+