# Index (Apache Commons CSV 1.2 API)

C D E F G H I M N O P Q R S T V W

## C

close() - Method in class org.apache.commons.csv.CSVParser
  Closes resources.
close() - Method in class org.apache.commons.csv.CSVPrinter
CSVFormat - Class in org.apache.commons.csv
  Specifies the format of a CSV file and parses input.
CSVFormat.Predefined - Enum in org.apache.commons.csv
  Predefines formats.
CSVParser - Class in org.apache.commons.csv
  Parses CSV files according to the specified format.
CSVParser(Reader, CSVFormat) - Constructor for class org.apache.commons.csv.CSVParser
  Customized CSV parser using the given `CSVFormat`
CSVParser(Reader, CSVFormat, long, long) - Constructor for class org.apache.commons.csv.CSVParser
  Customized CSV parser using the given `CSVFormat`
CSVPrinter - Class in org.apache.commons.csv
  Prints values in a CSV format.
CSVPrinter(Appendable, CSVFormat) - Constructor for class org.apache.commons.csv.CSVPrinter
  Creates a printer that will print values to the given stream following the CSVFormat.
CSVRecord - Class in org.apache.commons.csv
  A CSV record parsed from a CSV file.

## D

DEFAULT - Static variable in class org.apache.commons.csv.CSVFormat
  Standard comma separated format, as for `CSVFormat.RFC4180` but allowing empty lines.

## E

equals(Object) - Method in class org.apache.commons.csv.CSVFormat
EXCEL - Static variable in class org.apache.commons.csv.CSVFormat
  Excel file format (using a comma as the value delimiter).

## F

flush() - Method in class org.apache.commons.csv.CSVPrinter
  Flushes the underlying stream.
format(Object...) - Method in class org.apache.commons.csv.CSVFormat
  Formats the specified values.

## G

get(Enum<?>) - Method in class org.apache.commons.csv.CSVRecord
  Returns a value by `Enum`.
get(int) - Method in class org.apache.commons.csv.CSVRecord
  Returns a value by index.
get(String) - Method in class org.apache.commons.csv.CSVRecord
  Returns a value by name.
getAllowMissingColumnNames() - Method in class org.apache.commons.csv.CSVFormat
  Specifies whether missing column names are allowed when parsing the header line.
getCharacterPosition() - Method in class org.apache.commons.csv.CSVRecord
  Returns the start position of this record as a character position in the source stream.
getComment() - Method in class org.apache.commons.csv.CSVRecord
  Returns the comment for this record, if any.
getCommentMarker() - Method in class org.apache.commons.csv.CSVFormat
  Returns the character marking the start of a line comment.
getCurrentLineNumber() - Method in class org.apache.commons.csv.CSVParser
  Returns the current line number in the input stream.
getDelimiter() - Method in class org.apache.commons.csv.CSVFormat
  Returns the character delimiting the values (typically ';', ',' or '\t').
getEscapeCharacter() - Method in class org.apache.commons.csv.CSVFormat
  Returns the escape character.
getFormat() - Method in enum org.apache.commons.csv.CSVFormat.Predefined
  Gets the format.
getHeader() - Method in class org.apache.commons.csv.CSVFormat
  Returns a copy of the header array.
getHeaderComments() - Method in class org.apache.commons.csv.CSVFormat
  Returns a copy of the header comment array.
getHeaderMap() - Method in class org.apache.commons.csv.CSVParser
  Returns a copy of the header map that iterates in column order.
getIgnoreEmptyLines() - Method in class org.apache.commons.csv.CSVFormat
  Specifies whether empty lines between records are ignored when parsing input.
getIgnoreSurroundingSpaces() - Method in class org.apache.commons.csv.CSVFormat
  Specifies whether spaces around values are ignored when parsing input.
getNullString() - Method in class org.apache.commons.csv.CSVFormat
  Gets the String to convert to and from `null`.
getOut() - Method in class org.apache.commons.csv.CSVPrinter
  Gets the target Appendable.
getQuoteCharacter() - Method in class org.apache.commons.csv.CSVFormat
  Returns the character used to encapsulate values containing special characters.
getQuoteMode() - Method in class org.apache.commons.csv.CSVFormat
  Returns the quote policy output fields.
getRecordNumber() - Method in class org.apache.commons.csv.CSVParser
  Returns the current record number in the input stream.
getRecordNumber() - Method in class org.apache.commons.csv.CSVRecord
  Returns the number of this record in the parsed CSV file.
getRecords() - Method in class org.apache.commons.csv.CSVParser
  Parses the CSV input according to the given format and returns the content as a list of `CSVRecords`.
getRecordSeparator() - Method in class org.apache.commons.csv.CSVFormat
  Returns the record separator delimiting output records.
getSkipHeaderRecord() - Method in class org.apache.commons.csv.CSVFormat
  Returns whether to skip the header record.

## H

hashCode() - Method in class org.apache.commons.csv.CSVFormat

## I

isClosed() - Method in class org.apache.commons.csv.CSVParser
  Gets whether this parser is closed.
isCommentMarkerSet() - Method in class org.apache.commons.csv.CSVFormat
  Specifies whether comments are supported by this format.
isConsistent() - Method in class org.apache.commons.csv.CSVRecord
  Tells whether the record size matches the header size.
isEscapeCharacterSet() - Method in class org.apache.commons.csv.CSVFormat
  Returns whether escape are being processed.
isMapped(String) - Method in class org.apache.commons.csv.CSVRecord
  Checks whether a given column is mapped, i.e.
isNullStringSet() - Method in class org.apache.commons.csv.CSVFormat
  Returns whether a nullString has been defined.
isQuoteCharacterSet() - Method in class org.apache.commons.csv.CSVFormat
  Returns whether a quoteChar has been defined.
isSet(String) - Method in class org.apache.commons.csv.CSVRecord
  Checks whether a given columns is mapped and has a value.
iterator() - Method in class org.apache.commons.csv.CSVParser
  Returns an iterator on the records.
iterator() - Method in class org.apache.commons.csv.CSVRecord
  Returns an iterator over the values of this record.

## M

MYSQL - Static variable in class org.apache.commons.csv.CSVFormat
  Default MySQL format used by the `SELECT INTO OUTFILE` and `LOAD DATA INFILE` operations.

## N

newFormat(char) - Static method in class org.apache.commons.csv.CSVFormat
  Creates a new CSV format with the specified delimiter.

## O

org.apache.commons.csv - package org.apache.commons.csv
  Apache Commons CSV Format Support.

## P

parse(Reader) - Method in class org.apache.commons.csv.CSVFormat
  Parses the specified content.
parse(File, Charset, CSVFormat) - Static method in class org.apache.commons.csv.CSVParser
  Creates a parser for the given `File`.
parse(String, CSVFormat) - Static method in class org.apache.commons.csv.CSVParser
  Creates a parser for the given `String`.
parse(URL, Charset, CSVFormat) - Static method in class org.apache.commons.csv.CSVParser
  Creates a parser for the given URL.
print(Appendable) - Method in class org.apache.commons.csv.CSVFormat
  Prints to the specified output.
print(Object) - Method in class org.apache.commons.csv.CSVPrinter
  Prints the string as the next value on the line.
printComment(String) - Method in class org.apache.commons.csv.CSVPrinter
  Prints a comment on a new line among the delimiter separated values.
println() - Method in class org.apache.commons.csv.CSVPrinter
  Outputs the record separator.
printRecord(Iterable<?>) - Method in class org.apache.commons.csv.CSVPrinter
  Prints the given values a single record of delimiter separated values followed by the record separator.
printRecord(Object...) - Method in class org.apache.commons.csv.CSVPrinter
  Prints the given values a single record of delimiter separated values followed by the record separator.
printRecords(Iterable<?>) - Method in class org.apache.commons.csv.CSVPrinter
  Prints all the objects in the given collection handling nested collections/arrays as records.
printRecords(Object...) - Method in class org.apache.commons.csv.CSVPrinter
  Prints all the objects in the given array handling nested collections/arrays as records.
printRecords(ResultSet) - Method in class org.apache.commons.csv.CSVPrinter
  Prints all the objects in the given JDBC result set.

## Q

QuoteMode - Enum in org.apache.commons.csv
  Defines quote behavior when printing.

## R

RFC4180 - Static variable in class org.apache.commons.csv.CSVFormat
  Comma separated format as defined by RFC 4180.

## S

size() - Method in class org.apache.commons.csv.CSVRecord
  Returns the number of values in this record.

## T

TDF - Static variable in class org.apache.commons.csv.CSVFormat
  Tab-delimited format.
toMap() - Method in class org.apache.commons.csv.CSVRecord
  Copies this record into a new Map.
toString() - Method in class org.apache.commons.csv.CSVFormat
toString() - Method in class org.apache.commons.csv.CSVRecord
  Returns a string representation of the contents of this record.

## V

valueOf(String) - Static method in enum org.apache.commons.csv.CSVFormat.Predefined
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in class org.apache.commons.csv.CSVFormat
  Gets one of the predefined formats from `CSVFormat.Predefined`.
valueOf(String) - Static method in enum org.apache.commons.csv.QuoteMode
  Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.commons.csv.CSVFormat.Predefined
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.commons.csv.QuoteMode
  Returns an array containing the constants of this enum type, in the order they are declared.

## W

withAllowMissingColumnNames() - Method in class org.apache.commons.csv.CSVFormat
  Sets the missing column names behavior of the format to `true`
withAllowMissingColumnNames(boolean) - Method in class org.apache.commons.csv.CSVFormat
  Sets the missing column names behavior of the format.
withCommentMarker(char) - Method in class org.apache.commons.csv.CSVFormat
  Sets the comment start marker of the format to the specified character.
withCommentMarker(Character) - Method in class org.apache.commons.csv.CSVFormat
  Sets the comment start marker of the format to the specified character.
withDelimiter(char) - Method in class org.apache.commons.csv.CSVFormat
  Sets the delimiter of the format to the specified character.
withEscape(char) - Method in class org.apache.commons.csv.CSVFormat
  Sets the escape character of the format to the specified character.
withEscape(Character) - Method in class org.apache.commons.csv.CSVFormat
  Sets the escape character of the format to the specified character.
withHeader(String...) - Method in class org.apache.commons.csv.CSVFormat
  Sets the header of the format.
withHeader(ResultSet) - Method in class org.apache.commons.csv.CSVFormat
  Sets the header of the format.
withHeader(ResultSetMetaData) - Method in class org.apache.commons.csv.CSVFormat
  Sets the header of the format.
withHeaderComments(Object...) - Method in class org.apache.commons.csv.CSVFormat
  Sets the header comments of the format.
withIgnoreEmptyLines() - Method in class org.apache.commons.csv.CSVFormat
  Sets the empty line skipping behavior of the format to `true`.
withIgnoreEmptyLines(boolean) - Method in class org.apache.commons.csv.CSVFormat
  Sets the empty line skipping behavior of the format.
withIgnoreSurroundingSpaces() - Method in class org.apache.commons.csv.CSVFormat
  Sets the trimming behavior of the format to `true`.
withIgnoreSurroundingSpaces(boolean) - Method in class org.apache.commons.csv.CSVFormat
  Sets the trimming behavior of the format.
withNullString(String) - Method in class org.apache.commons.csv.CSVFormat
  Performs conversions to and from null for strings on input and output.
withQuote(char) - Method in class org.apache.commons.csv.CSVFormat
  Sets the quoteChar of the format to the specified character.
withQuote(Character) - Method in class org.apache.commons.csv.CSVFormat
  Sets the quoteChar of the format to the specified character.
withQuoteMode(QuoteMode) - Method in class org.apache.commons.csv.CSVFormat
  Sets the output quote policy of the format to the specified value.
withRecordSeparator(char) - Method in class org.apache.commons.csv.CSVFormat
  Sets the record separator of the format to the specified character.
withRecordSeparator(String) - Method in class org.apache.commons.csv.CSVFormat
  Sets the record separator of the format to the specified String.
withSkipHeaderRecord() - Method in class org.apache.commons.csv.CSVFormat
  Sets skipping the header record to `true`.
withSkipHeaderRecord(boolean) - Method in class org.apache.commons.csv.CSVFormat
  Sets whether to skip the header record.

C D E F G H I M N O P Q R S T V W

Copyright © 2015 The Apache Software Foundation. All rights reserved.