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

B

build() - Method in class org.apache.commons.csv.CSVFormat.Builder
Builds a new CSVFormat instance.
builder() - Method in class org.apache.commons.csv.CSVFormat
Creates a new Builder for this instance.

C

close() - Method in class org.apache.commons.csv.CSVParser
Closes resources.
close() - Method in class org.apache.commons.csv.CSVPrinter
 
close(boolean) - Method in class org.apache.commons.csv.CSVPrinter
Closes the underlying stream with an optional flush first.
create() - Static method in class org.apache.commons.csv.CSVFormat.Builder
Creates a new default builder.
create(CSVFormat) - Static method in class org.apache.commons.csv.CSVFormat.Builder
Creates a new builder for the given format.
CSVFormat - Class in org.apache.commons.csv
Specifies the format of a CSV file for parsing and writing.
CSVFormat.Builder - Class in org.apache.commons.csv
Builds CSVFormat instances.
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
Constructs a new instance using the given CSVFormat
CSVParser(Reader, CSVFormat, long, long) - Constructor for class org.apache.commons.csv.CSVParser
Constructs a new instance 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 Value format, as for CSVFormat.RFC4180 but allowing empty lines.
DuplicateHeaderMode - Enum in org.apache.commons.csv
Determines how duplicate header fields should be handled if CSVFormat.Builder.setHeader(Class) is not null.

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.
getAllowDuplicateHeaderNames() - Method in class org.apache.commons.csv.CSVFormat
getAllowMissingColumnNames() - Method in class org.apache.commons.csv.CSVFormat
Gets whether missing column names are allowed when parsing the header line.
getAutoFlush() - Method in class org.apache.commons.csv.CSVFormat
Gets whether to flush on close.
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
Gets the character marking the start of a line comment.
getCurrentLineNumber() - Method in class org.apache.commons.csv.CSVParser
Gets the current line number in the input stream.
getDelimiter() - Method in class org.apache.commons.csv.CSVFormat
getDelimiterString() - Method in class org.apache.commons.csv.CSVFormat
Gets the character delimiting the values (typically ";", "," or "\t").
getDuplicateHeaderMode() - Method in class org.apache.commons.csv.CSVFormat
Gets how duplicate headers are handled.
getEscapeCharacter() - Method in class org.apache.commons.csv.CSVFormat
Gets the escape character.
getFirstEndOfLine() - Method in class org.apache.commons.csv.CSVParser
Gets the first end-of-line string encountered.
getFormat() - Method in enum org.apache.commons.csv.CSVFormat.Predefined
Gets the format.
getHeader() - Method in class org.apache.commons.csv.CSVFormat
Gets a copy of the header array.
getHeaderComment() - Method in class org.apache.commons.csv.CSVParser
Gets the header comment, if any.
getHeaderComments() - Method in class org.apache.commons.csv.CSVFormat
Gets a copy of the header comment array.
getHeaderMap() - Method in class org.apache.commons.csv.CSVParser
Gets a copy of the header map as defined in the CSVFormat's header.
getHeaderNames() - Method in class org.apache.commons.csv.CSVParser
Gets a read-only list of header names that iterates in column order as defined in the CSVFormat's header.
getIgnoreEmptyLines() - Method in class org.apache.commons.csv.CSVFormat
Gets whether empty lines between records are ignored when parsing input.
getIgnoreHeaderCase() - Method in class org.apache.commons.csv.CSVFormat
Gets whether header names will be accessed ignoring case when parsing input.
getIgnoreSurroundingSpaces() - Method in class org.apache.commons.csv.CSVFormat
Gets 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.
getParser() - Method in class org.apache.commons.csv.CSVRecord
Returns the parser.
getQuoteCharacter() - Method in class org.apache.commons.csv.CSVFormat
Gets the character used to encapsulate values containing special characters.
getQuoteMode() - Method in class org.apache.commons.csv.CSVFormat
Gets the quote policy output fields.
getRecordNumber() - Method in class org.apache.commons.csv.CSVParser
Gets 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
Gets the record separator delimiting output records.
getSkipHeaderRecord() - Method in class org.apache.commons.csv.CSVFormat
Gets whether to skip the header record.
getTrailerComment() - Method in class org.apache.commons.csv.CSVParser
Gets the trailer comment, if any.
getTrailingDelimiter() - Method in class org.apache.commons.csv.CSVFormat
Gets whether to add a trailing delimiter.
getTrim() - Method in class org.apache.commons.csv.CSVFormat
Gets whether to trim leading and trailing blanks.

H

hasComment() - Method in class org.apache.commons.csv.CSVRecord
Checks whether this record has a comment, false otherwise.
hashCode() - Method in class org.apache.commons.csv.CSVFormat
 
hasHeaderComment() - Method in class org.apache.commons.csv.CSVParser
Checks whether there is a header comment.
hasTrailerComment() - Method in class org.apache.commons.csv.CSVParser
Checks whether there is a trailer comment.

I

INFORMIX_UNLOAD - Static variable in class org.apache.commons.csv.CSVFormat
Default Informix CSV UNLOAD format used by the UNLOAD TO file_name operation.
INFORMIX_UNLOAD_CSV - Static variable in class org.apache.commons.csv.CSVFormat
Default Informix CSV UNLOAD format used by the UNLOAD TO file_name operation (escaping is disabled.)
isClosed() - Method in class org.apache.commons.csv.CSVParser
Tests whether this parser is closed.
isCommentMarkerSet() - Method in class org.apache.commons.csv.CSVFormat
Tests 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
Tests 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
Tests whether a nullString has been defined.
isQuoteCharacterSet() - Method in class org.apache.commons.csv.CSVFormat
Tests whether a quoteChar has been defined.
isSet(int) - Method in class org.apache.commons.csv.CSVRecord
Checks whether a column with given index has a value.
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 the record iterator.
iterator() - Method in class org.apache.commons.csv.CSVRecord
Returns an iterator over the values of this record.

M

MONGODB_CSV - Static variable in class org.apache.commons.csv.CSVFormat
Default MongoDB CSV format used by the mongoexport operation.
MONGODB_TSV - Static variable in class org.apache.commons.csv.CSVFormat
Default MongoDB TSV format used by the mongoexport operation.
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

ORACLE - Static variable in class org.apache.commons.csv.CSVFormat
Default Oracle format used by the SQL*Loader utility.
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(InputStream, Charset, CSVFormat) - Static method in class org.apache.commons.csv.CSVParser
Creates a CSV parser using the given CSVFormat.
parse(Path, Charset, CSVFormat) - Static method in class org.apache.commons.csv.CSVParser
Creates and returns a parser for the given Path, which the caller MUST close.
parse(Reader, CSVFormat) - Static method in class org.apache.commons.csv.CSVParser
Creates a CSV parser using the given CSVFormat
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 and returns a parser for the given URL, which the caller MUST close.
POSTGRESQL_CSV - Static variable in class org.apache.commons.csv.CSVFormat
Default PostgreSQL CSV format used by the COPY operation.
POSTGRESQL_TEXT - Static variable in class org.apache.commons.csv.CSVFormat
Default PostgreSQL text format used by the COPY operation.
print(Appendable) - Method in class org.apache.commons.csv.CSVFormat
Prints to the specified output.
print(File, Charset) - Method in class org.apache.commons.csv.CSVFormat
Prints to the specified output.
print(Object, Appendable, boolean) - Method in class org.apache.commons.csv.CSVFormat
Prints the value as the next value on the line to out.
print(Path, Charset) - Method in class org.apache.commons.csv.CSVFormat
Prints to the specified output, returns a CSVPrinter which the caller MUST close.
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.
printer() - Method in class org.apache.commons.csv.CSVFormat
Prints to the System.out.
printHeaders(ResultSet) - Method in class org.apache.commons.csv.CSVPrinter
Prints headers for a result set based on its metadata.
println(Appendable) - Method in class org.apache.commons.csv.CSVFormat
Outputs the trailing delimiter (if set) followed by the record separator (if set).
println() - Method in class org.apache.commons.csv.CSVPrinter
Outputs the record separator.
printRecord(Appendable, Object...) - Method in class org.apache.commons.csv.CSVFormat
Prints the given values to out as a single record of delimiter separated values followed by the record separator.
printRecord(Iterable<?>) - Method in class org.apache.commons.csv.CSVPrinter
Prints the given values as 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 as a single record of delimiter separated values followed by the record separator.
printRecord(Stream<?>) - Method in class org.apache.commons.csv.CSVPrinter
Prints the given values as 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 Iterable 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.
printRecords(ResultSet, boolean) - Method in class org.apache.commons.csv.CSVPrinter
Prints all the objects with metadata in the given JDBC result set based on the header boolean.
printRecords(Stream<?>) - Method in class org.apache.commons.csv.CSVPrinter
Prints all the objects in the given Stream handling nested collections/arrays as records.
putIn(M) - Method in class org.apache.commons.csv.CSVRecord
Puts all values of this record into the given Map.

Q

QuoteMode - Enum in org.apache.commons.csv
Defines quoting behavior.

R

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

S

setAllowDuplicateHeaderNames(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
setAllowMissingColumnNames(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the parser missing column names behavior, true to allow missing column names in the header line, false to cause an IllegalArgumentException to be thrown.
setAutoFlush(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets whether to flush on close.
setCommentMarker(char) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the comment start marker, use null to disable.
setCommentMarker(Character) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the comment start marker, use null to disable.
setDelimiter(char) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the delimiter character.
setDelimiter(String) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the delimiter character.
setDuplicateHeaderMode(DuplicateHeaderMode) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the duplicate header names behavior.
setEscape(char) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the escape character.
setEscape(Character) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the escape character.
setHeader(Class<? extends Enum<?>>) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the header defined by the given Enum class.
setHeader(ResultSet) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the header from the result set metadata.
setHeader(ResultSetMetaData) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the header from the result set metadata.
setHeader(String...) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the header to the given values.
setHeaderComments(Object...) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the header comments set to the given values.
setHeaderComments(String...) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the header comments set to the given values.
setIgnoreEmptyLines(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the empty line skipping behavior, true to ignore the empty lines between the records, false to translate empty lines to empty records.
setIgnoreHeaderCase(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the parser case mapping behavior, true to access name/values, false to leave the mapping as is.
setIgnoreSurroundingSpaces(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the parser trimming behavior, true to remove the surrounding spaces, false to leave the spaces as is.
setNullString(String) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the String to convert to and from null.
setQuote(char) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the quote character.
setQuote(Character) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the quote character, use null to disable.
setQuoteMode(QuoteMode) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the quote policy to use for output.
setRecordSeparator(char) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the record separator to use for output.
setRecordSeparator(String) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets the record separator to use for output.
setSkipHeaderRecord(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets whether to skip the header record.
setTrailingDelimiter(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets whether to add a trailing delimiter.
setTrim(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
Sets whether to trim leading and trailing blanks.
size() - Method in class org.apache.commons.csv.CSVRecord
Returns the number of values in this record.
stream() - Method in class org.apache.commons.csv.CSVParser
Returns a sequential Stream with this collection as its source.
stream() - Method in class org.apache.commons.csv.CSVRecord
Returns a sequential ordered stream whose elements are the values.

T

TDF - Static variable in class org.apache.commons.csv.CSVFormat
Tab-delimited format.
toList() - Method in class org.apache.commons.csv.CSVRecord
Converts the values to a new List.
toMap() - Method in class org.apache.commons.csv.CSVRecord
Copies this record into a new Map of header name to record value.
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.DuplicateHeaderMode
Returns the enum constant of this type with the specified name.
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() - Method in class org.apache.commons.csv.CSVRecord
Gets the values for this record.
values() - Static method in enum org.apache.commons.csv.DuplicateHeaderMode
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

withAllowDuplicateHeaderNames() - Method in class org.apache.commons.csv.CSVFormat
withAllowDuplicateHeaderNames(boolean) - Method in class org.apache.commons.csv.CSVFormat
withAllowMissingColumnNames() - Method in class org.apache.commons.csv.CSVFormat
withAllowMissingColumnNames(boolean) - Method in class org.apache.commons.csv.CSVFormat
withAutoFlush(boolean) - Method in class org.apache.commons.csv.CSVFormat
withCommentMarker(char) - Method in class org.apache.commons.csv.CSVFormat
withCommentMarker(Character) - Method in class org.apache.commons.csv.CSVFormat
withDelimiter(char) - Method in class org.apache.commons.csv.CSVFormat
withEscape(char) - Method in class org.apache.commons.csv.CSVFormat
withEscape(Character) - Method in class org.apache.commons.csv.CSVFormat
withFirstRecordAsHeader() - Method in class org.apache.commons.csv.CSVFormat
withHeader(Class<? extends Enum<?>>) - Method in class org.apache.commons.csv.CSVFormat
withHeader(ResultSet) - Method in class org.apache.commons.csv.CSVFormat
withHeader(ResultSetMetaData) - Method in class org.apache.commons.csv.CSVFormat
withHeader(String...) - Method in class org.apache.commons.csv.CSVFormat
withHeaderComments(Object...) - Method in class org.apache.commons.csv.CSVFormat
withIgnoreEmptyLines() - Method in class org.apache.commons.csv.CSVFormat
withIgnoreEmptyLines(boolean) - Method in class org.apache.commons.csv.CSVFormat
withIgnoreHeaderCase() - Method in class org.apache.commons.csv.CSVFormat
withIgnoreHeaderCase(boolean) - Method in class org.apache.commons.csv.CSVFormat
withIgnoreSurroundingSpaces() - Method in class org.apache.commons.csv.CSVFormat
withIgnoreSurroundingSpaces(boolean) - Method in class org.apache.commons.csv.CSVFormat
withNullString(String) - Method in class org.apache.commons.csv.CSVFormat
withQuote(char) - Method in class org.apache.commons.csv.CSVFormat
withQuote(Character) - Method in class org.apache.commons.csv.CSVFormat
withQuoteMode(QuoteMode) - Method in class org.apache.commons.csv.CSVFormat
withRecordSeparator(char) - Method in class org.apache.commons.csv.CSVFormat
withRecordSeparator(String) - Method in class org.apache.commons.csv.CSVFormat
withSkipHeaderRecord() - Method in class org.apache.commons.csv.CSVFormat
withSkipHeaderRecord(boolean) - Method in class org.apache.commons.csv.CSVFormat
withSystemRecordSeparator() - Method in class org.apache.commons.csv.CSVFormat
withTrailingDelimiter() - Method in class org.apache.commons.csv.CSVFormat
withTrailingDelimiter(boolean) - Method in class org.apache.commons.csv.CSVFormat
withTrim() - Method in class org.apache.commons.csv.CSVFormat
Deprecated.
withTrim(boolean) - Method in class org.apache.commons.csv.CSVFormat
B C D E F G H I M N O P Q R S T V W 
Skip navigation links

Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.