Alphabetical Index

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

A

addField(org.apache.commons.csv.writer.CSVField) - method in class org.apache.commons.csv.writer.CSVConfig
analyseLines(String[]) - method in class org.apache.commons.csv.writer.CSVConfigGuesser
append(char) - method in class org.apache.commons.csv.CharBuffer
Appends a single character to the end of this CharBuffer.
append(char[]) - method in class org.apache.commons.csv.CharBuffer
Appends data to the end of this CharBuffer.
append(org.apache.commons.csv.CharBuffer) - method in class org.apache.commons.csv.CharBuffer
Appends the contents of cb to the end of this CharBuffer.
append(String) - method in class org.apache.commons.csv.CharBuffer
Appends s to the end of this CharBuffer.
append(StringBuffer) - method in class org.apache.commons.csv.CharBuffer
Appends sb to the end of this CharBuffer.

C

c - field in class org.apache.commons.csv.CharBuffer
capacity() - method in class org.apache.commons.csv.CharBuffer
Returns the current capacity of the buffer.
CharBuffer - class org.apache.commons.csv.CharBuffer
A simple StringBuffer replacement that aims to reduce copying as much as possible.
CharBuffer() - constructor for class org.apache.commons.csv.CharBuffer
Creates a new CharBuffer with an initial capacity of 32 characters.
CharBuffer(int) - constructor for class org.apache.commons.csv.CharBuffer
Creates a new CharBuffer with an initial capacity of length characters.
clear() - method in class org.apache.commons.csv.CharBuffer
Empties the buffer.
clone() - method in class org.apache.commons.csv.CSVStrategy
code - field in class org.apache.commons.csv.CSVParser
COMMENTS_DISABLED - static field in class org.apache.commons.csv.CSVStrategy
commentStart - field in class org.apache.commons.csv.CSVStrategy
config - field in class org.apache.commons.csv.writer.CSVConfigGuesser
The found config
config - field in class org.apache.commons.csv.writer.CSVWriter
The CSV config *
content - field in class org.apache.commons.csv.CSVParser.Token
The content buffer.
CSVConfig - class org.apache.commons.csv.writer.CSVConfig
The CSVConfig is used to configure the CSV writer
CSVConfig() - constructor for class org.apache.commons.csv.writer.CSVConfig
CSVConfigGuesser - class org.apache.commons.csv.writer.CSVConfigGuesser
Tries to guess a config based on an InputStream.
CSVConfigGuesser() - constructor for class org.apache.commons.csv.writer.CSVConfigGuesser
CSVConfigGuesser(InputStream) - constructor for class org.apache.commons.csv.writer.CSVConfigGuesser
CSVField - class org.apache.commons.csv.writer.CSVField
CSVField() - constructor for class org.apache.commons.csv.writer.CSVField
CSVField(String) - constructor for class org.apache.commons.csv.writer.CSVField
CSVField(String,int) - constructor for class org.apache.commons.csv.writer.CSVField
CSVParser - class org.apache.commons.csv.CSVParser
Parses CSV files according to the specified configuration.
CSVParser(InputStream) - constructor for class org.apache.commons.csv.CSVParser
Default strategy for the parser follows the default CSVStrategy.
CSVParser(Reader) - constructor for class org.apache.commons.csv.CSVParser
CSV parser using the default CSVStrategy.
CSVParser(Reader,char) - constructor for class org.apache.commons.csv.CSVParser
Customized value delimiter parser.
CSVParser(Reader,char,char,char) - constructor for class org.apache.commons.csv.CSVParser
Customized csv parser.
CSVParser(Reader,org.apache.commons.csv.CSVStrategy) - constructor for class org.apache.commons.csv.CSVParser
Customized CSV parser using the given CSVStrategy
CSVPrinter - class org.apache.commons.csv.CSVPrinter
Print values as a comma separated list.
CSVPrinter(OutputStream) - constructor for class org.apache.commons.csv.CSVPrinter
Create a printer that will print values to the given stream.
CSVPrinter(Writer) - constructor for class org.apache.commons.csv.CSVPrinter
Create a printer that will print values to the given stream.
CSVStrategy - class org.apache.commons.csv.CSVStrategy
CSVStrategy Represents the strategy for a CSV.
CSVStrategy(char,char,char) - constructor for class org.apache.commons.csv.CSVStrategy
CSVStrategy(char,char,char,boolean,boolean,boolean) - constructor for class org.apache.commons.csv.CSVStrategy
Customized CSV strategy setter.
CSVUtils - class org.apache.commons.csv.CSVUtils
Utility methods for dealing with CSV files
CSVUtils() - constructor for class org.apache.commons.csv.CSVUtils
CSVUtils instances should NOT be constructed in standard programming.
CSVWriter - class org.apache.commons.csv.writer.CSVWriter
CSVWriter
CSVWriter() - constructor for class org.apache.commons.csv.writer.CSVWriter
CSVWriter(org.apache.commons.csv.writer.CSVConfig) - constructor for class org.apache.commons.csv.writer.CSVWriter

D

DEFAULT_STRATEGY - static field in class org.apache.commons.csv.CSVStrategy
delimiter - field in class org.apache.commons.csv.writer.CSVConfig
The seperator character.
delimiter - field in class org.apache.commons.csv.CSVStrategy

E

EMPTY_DOUBLE_STRING_ARRAY - static field in class org.apache.commons.csv.CSVUtils
EMPTY_STRING_ARRAY - static field in class org.apache.commons.csv.CSVParser
Immutable empty String array.
EMPTY_STRING_ARRAY - static field in class org.apache.commons.csv.CSVUtils
An encapsulated token lexer Encapsulated tokens are surrounded by the given encapsulating-string.
encapsulator - field in class org.apache.commons.csv.CSVStrategy
END_OF_STREAM - static field in class org.apache.commons.csv.ExtendedBufferedReader
the end of stream symbol
endTrimmed - field in class org.apache.commons.csv.writer.CSVConfig
Specifies if the end of the line needs to be trimmed
equals(Object) - method in class org.apache.commons.csv.writer.CSVConfig
TODO..
escapeAndQuote(String) - method in class org.apache.commons.csv.CSVPrinter
Enclose the value in quotes and escape the quote and comma characters that are inside.
EXCEL_STRATEGY - static field in class org.apache.commons.csv.CSVStrategy
ExtendedBufferedReader - class org.apache.commons.csv.ExtendedBufferedReader
ExtendedBufferedReader A special reader decorater which supports more sophisticated access to the underlying reader object.
ExtendedBufferedReader(Reader) - constructor for class org.apache.commons.csv.ExtendedBufferedReader
Created extended buffered reader using default buffer-size
ExtendedBufferedReader(Reader,int) - constructor for class org.apache.commons.csv.ExtendedBufferedReader
Create extended buffered reader using the given buffer-size

F

fieldHeader - field in class org.apache.commons.csv.writer.CSVConfig
Specifies if we want to use a field header
fields - field in class org.apache.commons.csv.writer.CSVConfig
list of fields *
fill - field in class org.apache.commons.csv.writer.CSVConfig
The fill pattern
fill - field in class org.apache.commons.csv.writer.CSVField
fillChar - field in class org.apache.commons.csv.writer.CSVConfig
The fill char.
FILLLEFT - static field in class org.apache.commons.csv.writer.CSVConfig
Fill content the the left.
FILLNONE - static field in class org.apache.commons.csv.writer.CSVConfig
Do no do any filling *
FILLRIGHT - static field in class org.apache.commons.csv.writer.CSVConfig
Fill content to the right.
fixedWidth - field in class org.apache.commons.csv.writer.CSVConfig
specifies if it is a fixed width csv file *

G

getAllValues() - method in class org.apache.commons.csv.CSVParser
Parses the CSV according to the given strategy and returns the content as an array of records (whereas records are arrays of single values).
getCharacters() - method in class org.apache.commons.csv.CharBuffer
Returns the contents of the buffer as a char[].
getCommentStart() - method in class org.apache.commons.csv.CSVStrategy
getConfig() - method in class org.apache.commons.csv.writer.CSVWriter
getDelimiter() - method in class org.apache.commons.csv.writer.CSVConfig
getDelimiter() - method in class org.apache.commons.csv.CSVStrategy
getEncapsulator() - method in class org.apache.commons.csv.CSVStrategy
getField(String) - method in class org.apache.commons.csv.writer.CSVConfig
getFields() - method in class org.apache.commons.csv.writer.CSVConfig
getFill() - method in class org.apache.commons.csv.writer.CSVConfig
getFill() - method in class org.apache.commons.csv.writer.CSVField
getFillChar() - method in class org.apache.commons.csv.writer.CSVConfig
getIgnoreEmptyLines() - method in class org.apache.commons.csv.CSVStrategy
getIgnoreLeadingWhitespaces() - method in class org.apache.commons.csv.CSVStrategy
getInputStream() - method in class org.apache.commons.csv.writer.CSVConfigGuesser
Allow override.
getLine() - method in class org.apache.commons.csv.CSVParser
Parses from the current point in the stream til the end of the current line.
getLineNumber() - method in class org.apache.commons.csv.CSVParser
Returns the current line number in the input stream.
getLineNumber() - method in class org.apache.commons.csv.ExtendedBufferedReader
Returns the nof line read ATTENTION: the skip-method does invalidate the line-number counter
getName() - method in class org.apache.commons.csv.writer.CSVField
getSize() - method in class org.apache.commons.csv.writer.CSVField
getStrategy() - method in class org.apache.commons.csv.CSVParser
Obtain the specified CSV Strategy
getStrategy() - method in class org.apache.commons.csv.CSVPrinter
Obtain the specified CSV Strategy
getUnicodeEscapeInterpretation() - method in class org.apache.commons.csv.CSVStrategy
getValueDelimiter() - method in class org.apache.commons.csv.writer.CSVConfig
guess() - method in class org.apache.commons.csv.writer.CSVConfigGuesser
Guess the config based on the first 10 (or less when less available) records of a CSV file.
guessConfig(InputStream) - static method in class org.apache.commons.csv.writer.CSVConfig
Creates a config based on a stream.
guessFieldSeperator(String[]) - method in class org.apache.commons.csv.writer.CSVConfigGuesser
guessFixedWidth(String[]) - method in class org.apache.commons.csv.writer.CSVConfigGuesser
Guess if this file is fixedwidth.
guessFixedWidthSeperator(String[]) - method in class org.apache.commons.csv.writer.CSVConfigGuesser

H

hasFieldHeader - field in class org.apache.commons.csv.writer.CSVConfigGuesser
if the file has a field header (need this info, to be able to guess better) Defaults to false
hasFieldHeader() - method in class org.apache.commons.csv.writer.CSVConfigGuesser

I

ignoreDelimiter - field in class org.apache.commons.csv.writer.CSVConfig
Should we ignore the delimiter.
ignoreEmptyLines - field in class org.apache.commons.csv.CSVStrategy
ignoreLeadingWhitespaces - field in class org.apache.commons.csv.CSVStrategy
ignoreValueDelimiter - field in class org.apache.commons.csv.writer.CSVConfig
Should we ignore the value delimiter.
in - field in class org.apache.commons.csv.writer.CSVConfigGuesser
The stream to read
in - field in class org.apache.commons.csv.CSVParser
INITIAL_TOKEN_LENGTH - static field in class org.apache.commons.csv.CSVParser
length of the initial token (content-)buffer
interpretUnicodeEscapes - field in class org.apache.commons.csv.CSVStrategy
isCommentingDisabled() - method in class org.apache.commons.csv.CSVStrategy
isDelimiterIgnored() - method in class org.apache.commons.csv.writer.CSVConfig
isEndOfFile(int) - method in class org.apache.commons.csv.CSVParser
isEndOfLine(int) - method in class org.apache.commons.csv.CSVParser
Greedy - accepts \n and \r\n This checker consumes silently the second control-character...
isEndTrimmed() - method in class org.apache.commons.csv.writer.CSVConfig
isFieldHeader() - method in class org.apache.commons.csv.writer.CSVConfig
isFixedWidth() - method in class org.apache.commons.csv.writer.CSVConfig
isReady - field in class org.apache.commons.csv.CSVParser.Token
Token ready flag: indicates a valid token with content (ready for the parser).
isValueDelimiterIgnored() - method in class org.apache.commons.csv.writer.CSVConfig
isWhitespace(int) - method in class org.apache.commons.csv.CSVParser

L

lastChar - field in class org.apache.commons.csv.ExtendedBufferedReader
the last char returned
length - field in class org.apache.commons.csv.CharBuffer
Actually used number of characters in the array.
length() - method in class org.apache.commons.csv.CharBuffer
Returns the number of characters in the buffer.
line - field in class org.apache.commons.csv.ExtendedBufferedReader
lineCounter - field in class org.apache.commons.csv.ExtendedBufferedReader
the line counter
lookAhead() - method in class org.apache.commons.csv.ExtendedBufferedReader
Returns the next char in the stream without consuming it.
lookaheadChar - field in class org.apache.commons.csv.ExtendedBufferedReader
the lookahead chars

M

markSupported() - method in class org.apache.commons.csv.ExtendedBufferedReader

N

name - field in class org.apache.commons.csv.writer.CSVField
newLine - field in class org.apache.commons.csv.CSVPrinter
True if we just began a new line.
nextToken() - method in class org.apache.commons.csv.CSVParser
Convenience method for nextToken(null).
nextToken(org.apache.commons.csv.CSVParser.Token) - method in class org.apache.commons.csv.CSVParser
Returns the next token.
nextValue() - method in class org.apache.commons.csv.CSVParser
Parses the CSV according to the given strategy and returns the next csv-value as string.

O

Jakarta-Commons CSV Format Support

CSV (or its dialects) are widely used as interfaces to legacy systems or manual data-imports.

out - field in class org.apache.commons.csv.CSVPrinter
The place that the values get written.
overrideFill - field in class org.apache.commons.csv.writer.CSVField
overrideFill() - method in class org.apache.commons.csv.writer.CSVField
Does this field override fill ?

P

parse(String) - static method in class org.apache.commons.csv.CSVUtils
Parses the given String according to the default CSVStrategy.
parseLine(String) - static method in class org.apache.commons.csv.CSVUtils
Parses the first line only according to the default CSVStrategy.
print(String) - method in class org.apache.commons.csv.CSVPrinter
Print the string as the next value on the line.
printLine(String[]) - static method in class org.apache.commons.csv.CSVUtils
Converts an array of string values into a single CSV line.
println() - method in class org.apache.commons.csv.CSVPrinter
Output a blank line
println(String) - method in class org.apache.commons.csv.CSVPrinter
Print the string as the last value on the line.
println(String[]) - method in class org.apache.commons.csv.CSVPrinter
Print a single line of comma separated values.
println(String[][]) - method in class org.apache.commons.csv.CSVPrinter
Print several lines of comma separated values.
printlnComment(String) - method in class org.apache.commons.csv.CSVPrinter
Put a comment among the comma separated values.
provideCapacity(int) - method in class org.apache.commons.csv.CharBuffer
Copies the data into a new array of at least capacity size.

R

read() - method in class org.apache.commons.csv.ExtendedBufferedReader
Reads the next char from the input stream.
read(char[],int,int) - method in class org.apache.commons.csv.ExtendedBufferedReader
Non-blocking reading of len chars into buffer buf starting at bufferposition off.
readAgain() - method in class org.apache.commons.csv.ExtendedBufferedReader
Returns the last read character again.
readLine() - method in class org.apache.commons.csv.ExtendedBufferedReader
readUntil(char) - method in class org.apache.commons.csv.ExtendedBufferedReader
Reads all characters up to (but not including) the given character.
record - field in class org.apache.commons.csv.CSVParser
A record buffer for getLine().
reset() - method in class org.apache.commons.csv.CSVParser.Token
reusableToken - field in class org.apache.commons.csv.CSVParser

S

setCommentStart(char) - method in class org.apache.commons.csv.CSVStrategy
setConfig(org.apache.commons.csv.writer.CSVConfig) - method in class org.apache.commons.csv.writer.CSVWriter
Set the CSVConfig
setDelimiter(char) - method in class org.apache.commons.csv.writer.CSVConfig
Set the delimiter to use
setDelimiter(char) - method in class org.apache.commons.csv.CSVStrategy
setEncapsulator(char) - method in class org.apache.commons.csv.CSVStrategy
setEndTrimmed(boolean) - method in class org.apache.commons.csv.writer.CSVConfig
Specify if the end of the line needs to be trimmed.
setFieldHeader(boolean) - method in class org.apache.commons.csv.writer.CSVConfig
Specify if you want to use a field header.
setFields(Collection) - method in class org.apache.commons.csv.writer.CSVConfig
Set the fields that should be used by the writer
setFields(org.apache.commons.csv.writer.CSVField[]) - method in class org.apache.commons.csv.writer.CSVConfig
Set the fields that should be used by the writer.
setFill(int) - method in class org.apache.commons.csv.writer.CSVConfig
Set the fill pattern.
setFill(int) - method in class org.apache.commons.csv.writer.CSVField
Sets overrideFill to true.
setFillChar(char) - method in class org.apache.commons.csv.writer.CSVConfig
Set the fill char
setFixedWidth(boolean) - method in class org.apache.commons.csv.writer.CSVConfig
Specify if the CSV file is fixed width.
setHasFieldHeader(boolean) - method in class org.apache.commons.csv.writer.CSVConfigGuesser
Specify if the CSV file has a field header
setIgnoreDelimiter(boolean) - method in class org.apache.commons.csv.writer.CSVConfig
Specify if the writer should ignore the delimiter.
setIgnoreEmptyLines(boolean) - method in class org.apache.commons.csv.CSVStrategy
setIgnoreLeadingWhitespaces(boolean) - method in class org.apache.commons.csv.CSVStrategy
setIgnoreValueDelimiter(boolean) - method in class org.apache.commons.csv.writer.CSVConfig
Specify if the writer should ignore the value delimiter.
setInputStream(InputStream) - method in class org.apache.commons.csv.writer.CSVConfigGuesser
setName(String) - method in class org.apache.commons.csv.writer.CSVField
Set the name of the field
setSize(int) - method in class org.apache.commons.csv.writer.CSVField
Set the size of the field.
setStrategy(org.apache.commons.csv.CSVStrategy) - method in class org.apache.commons.csv.CSVParser
Sets the specified CSV Strategy
setStrategy(org.apache.commons.csv.CSVStrategy) - method in class org.apache.commons.csv.CSVPrinter
Sets the specified CSV Strategy
setUnicodeEscapeInterpretation(boolean) - method in class org.apache.commons.csv.CSVStrategy
setValueDelimiter(char) - method in class org.apache.commons.csv.writer.CSVConfig
Set the value delimiter to use
setWriter(Writer) - method in class org.apache.commons.csv.writer.CSVWriter
Set the writer to write the CSV file to.
shrink() - method in class org.apache.commons.csv.CharBuffer
Shrinks the capacity of the buffer to the current length if necessary.
A simple token lexer Simple token are tokens which are not surrounded by encapsulators.
size - field in class org.apache.commons.csv.writer.CSVField
skip(long) - method in class org.apache.commons.csv.ExtendedBufferedReader
Skips char in the stream ATTENTION: invalidates the line-counter !!!!!
skipUntil(char) - method in class org.apache.commons.csv.ExtendedBufferedReader
Skips all chars in the input until (but excluding) the given char
strategy - field in class org.apache.commons.csv.CSVParser
strategy - field in class org.apache.commons.csv.CSVPrinter

T

TDF_STRATEGY - static field in class org.apache.commons.csv.CSVStrategy
CSVParser.Token - class org.apache.commons.csv.CSVParser.Token
Token is an internal token representation.
toString() - method in class org.apache.commons.csv.CharBuffer
Converts the contents of the buffer into a StringBuffer.
toStringBuffer() - method in class org.apache.commons.csv.CharBuffer
Converts the contents of the buffer into a StringBuffer.
TT_EOF - static field in class org.apache.commons.csv.CSVParser
Token (which can have content) when end of file is reached.
TT_EORECORD - static field in class org.apache.commons.csv.CSVParser
Token with content when end of a line is reached.
TT_INVALID - static field in class org.apache.commons.csv.CSVParser
Token has no valid content, i.e.
TT_TOKEN - static field in class org.apache.commons.csv.CSVParser
Token with content, at beginning or in the middle of a line.
type - field in class org.apache.commons.csv.CSVParser.Token
Token type, see TT_xxx constants.

U

UNDEFINED - static field in class org.apache.commons.csv.ExtendedBufferedReader
undefined state for the lookahead char
unicodeEscapeLexer(int) - method in class org.apache.commons.csv.CSVParser
Decodes Unicode escapes.

V

valueDelimiter - field in class org.apache.commons.csv.writer.CSVConfig
the value delimiter.

W

writer - field in class org.apache.commons.csv.writer.CSVWriter
The writer *
writeRecord(Map) - method in class org.apache.commons.csv.writer.CSVWriter
writeValue(org.apache.commons.csv.writer.CSVField,String) - method in class org.apache.commons.csv.writer.CSVWriter
wsBuf - field in class org.apache.commons.csv.CSVParser