A B C D E F G H I M N O P Q R S T V W
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ALL - org.apache.commons.csv.QuoteMode
-
Quotes all fields.
- ALL_NON_NULL - org.apache.commons.csv.QuoteMode
-
Quotes all non-null fields.
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 and parses input.
- 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
-
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 - org.apache.commons.csv.CSVFormat.Predefined
- DEFAULT - Static variable in class org.apache.commons.csv.CSVFormat
-
Standard Comma Separated Value format, as for
CSVFormat.RFC4180
but allowing empty lines.
E
- equals(Object) - Method in class org.apache.commons.csv.CSVFormat
- Excel - org.apache.commons.csv.CSVFormat.Predefined
- 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(int) - Method in class org.apache.commons.csv.CSVRecord
-
Returns a value by index.
- get(Enum<?>) - Method in class org.apache.commons.csv.CSVRecord
-
Returns a value by
Enum
. - get(String) - Method in class org.apache.commons.csv.CSVRecord
-
Returns a value by name.
- getAllowDuplicateHeaderNames() - Method in class org.apache.commons.csv.CSVFormat
-
Returns true if and only if duplicate names are allowed in the headers.
- getAllowMissingColumnNames() - Method in class org.apache.commons.csv.CSVFormat
-
Specifies whether missing column names are allowed when parsing the header line.
- getAutoFlush() - Method in class org.apache.commons.csv.CSVFormat
-
Returns 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
-
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
-
Deprecated.
- getDelimiterString() - 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.
- 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
-
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.
- getHeaderNames() - Method in class org.apache.commons.csv.CSVParser
-
Returns a read-only list of header names 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.
- getIgnoreHeaderCase() - Method in class org.apache.commons.csv.CSVFormat
-
Specifies whether header names will be accessed ignoring case.
- 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.
- getParser() - Method in class org.apache.commons.csv.CSVRecord
-
Returns the parser.
- 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.
- getTrailingDelimiter() - Method in class org.apache.commons.csv.CSVFormat
-
Returns whether to add a trailing delimiter.
- getTrim() - Method in class org.apache.commons.csv.CSVFormat
-
Returns 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
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.) - InformixUnload - org.apache.commons.csv.CSVFormat.Predefined
- InformixUnloadCsv - org.apache.commons.csv.CSVFormat.Predefined
- isClosed() - Method in class org.apache.commons.csv.CSVParser
-
Tests 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(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
- MINIMAL - org.apache.commons.csv.QuoteMode
-
Quotes fields which contain special characters such as a the field delimiter, quote character or any of the characters in the line separator string.
- 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. - MongoDBCsv - org.apache.commons.csv.CSVFormat.Predefined
- MongoDBTsv - org.apache.commons.csv.CSVFormat.Predefined
- MySQL - org.apache.commons.csv.CSVFormat.Predefined
- MYSQL - Static variable in class org.apache.commons.csv.CSVFormat
-
Default MySQL format used by the
SELECT INTO OUTFILE
andLOAD DATA INFILE
operations.
N
- newFormat(char) - Static method in class org.apache.commons.csv.CSVFormat
-
Creates a new CSV format with the specified delimiter.
- NON_NUMERIC - org.apache.commons.csv.QuoteMode
-
Quotes all non-numeric fields.
- NONE - org.apache.commons.csv.QuoteMode
-
Never quotes fields.
O
- Oracle - org.apache.commons.csv.CSVFormat.Predefined
- 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(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(Reader) - Method in class org.apache.commons.csv.CSVFormat
-
Parses the specified content.
- 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.
- 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. - 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. - PostgreSQLCsv - org.apache.commons.csv.CSVFormat.Predefined
- PostgreSQLText - org.apache.commons.csv.CSVFormat.Predefined
- print(File, Charset) - Method in class org.apache.commons.csv.CSVFormat
-
Prints to the specified output.
- 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.
- print(Object, Appendable, boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Prints the
value
as the next value on the line toout
. - print(Path, Charset) - Method in class org.apache.commons.csv.CSVFormat
-
Prints to the specified output, returns a
CSVPrinter
which the caller MUST close. - 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() - Method in class org.apache.commons.csv.CSVPrinter
-
Outputs the record separator.
- println(Appendable) - Method in class org.apache.commons.csv.CSVFormat
-
Outputs the trailing delimiter (if set) followed by the record separator (if set).
- printRecord(Appendable, Object...) - Method in class org.apache.commons.csv.CSVFormat
-
Prints the given
values
toout
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 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.
- 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.
- 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 - org.apache.commons.csv.CSVFormat.Predefined
- 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
-
Sets the duplicate header names behavior, true to allow, false to disallow.
- setAllowMissingColumnNames(boolean) - Method in class org.apache.commons.csv.CSVFormat.Builder
-
Sets the missing column names behavior,
true
to allow missing column names in the header line,false
to cause anIllegalArgumentException
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.
- 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(String...) - Method in class org.apache.commons.csv.CSVFormat.Builder
-
Sets the header to the given values.
- 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.
- 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 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 - org.apache.commons.csv.CSVFormat.Predefined
- 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 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.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
- withAllowDuplicateHeaderNames() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withAllowDuplicateHeaderNames(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withAllowMissingColumnNames() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withAllowMissingColumnNames(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withAutoFlush(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withCommentMarker(char) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withCommentMarker(Character) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withDelimiter(char) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withEscape(char) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withEscape(Character) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withFirstRecordAsHeader() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withHeader(Class<? extends Enum<?>>) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withHeader(String...) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withHeader(ResultSet) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withHeader(ResultSetMetaData) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withHeaderComments(Object...) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withIgnoreEmptyLines() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withIgnoreEmptyLines(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withIgnoreHeaderCase() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withIgnoreHeaderCase(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withIgnoreSurroundingSpaces() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withIgnoreSurroundingSpaces(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withNullString(String) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withQuote(char) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withQuote(Character) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withQuoteMode(QuoteMode) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withRecordSeparator(char) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withRecordSeparator(String) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withSkipHeaderRecord() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withSkipHeaderRecord(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withSystemRecordSeparator() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withTrailingDelimiter() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withTrailingDelimiter(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withTrim() - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
- withTrim(boolean) - Method in class org.apache.commons.csv.CSVFormat
-
Deprecated.
All Classes All Packages