Top Deprecated
Apache Commons CSV 1.14.0

Deprecated API


No API in this release is deprecated for removal.

Deprecated Item Summary

SinceDeprecated Item and Description

Returns:

a new CSVFormat instance.
org.apache.commons.csv.CSVFormat.Builder.build
()

Use get().

Returns:

This instance.
org.apache.commons.csv.CSVFormat.Builder.setAllowDuplicateHeaderNames
(final boolean
the duplicate header names behavior, true to allow, false to disallow.
allowDuplicateHeaderNames
)

Use setDuplicateHeaderMode(DuplicateHeaderMode).

Returns:

whether duplicate header names are allowed
org.apache.commons.csv.CSVFormat.getAllowDuplicateHeaderNames
()

Use getDuplicateHeaderMode().

Returns:

the first delimiter character.
org.apache.commons.csv.CSVFormat.getDelimiter
()

Use getDelimiterString().

Returns:

a new CSVFormat with duplicate header names behavior set to the given value.
org.apache.commons.csv.CSVFormat.withAllowDuplicateHeaderNames
(final boolean
the duplicate header names behavior, true to allow, false to disallow.
allowDuplicateHeaderNames
)

Use Builder#setAllowDuplicateHeaderNames(boolean)

Returns:

A new CSVFormat that is equal to this but with the specified missing column names behavior.
org.apache.commons.csv.CSVFormat.withAllowMissingColumnNames
()

Use Builder#setAllowMissingColumnNames(true)

Returns:

A new CSVFormat that is equal to this but with the specified missing column names behavior.
org.apache.commons.csv.CSVFormat.withAllowMissingColumnNames
(final boolean
the missing column names behavior, true to allow missing column names in the header line, false to cause an IllegalArgumentException to be thrown.
allowMissingColumnNames
)

Use Builder#setAllowMissingColumnNames(boolean)

Returns:

A new CSVFormat that is equal to this but with the specified autoFlush setting.
org.apache.commons.csv.CSVFormat.withAutoFlush
(final boolean
whether to flush on close.
autoFlush
)

Use Builder#setAutoFlush(boolean)

Returns:

A new CSVFormat that is equal to this one but with the specified character as the comment start marker
org.apache.commons.csv.CSVFormat.withCommentMarker
(final char
the comment start marker
commentMarker
)

Use Builder#setCommentMarker(char)

Returns:

A new CSVFormat that is equal to this one but with the specified character as the comment start marker
org.apache.commons.csv.CSVFormat.withCommentMarker
(final Character
the comment start marker, use null to disable
commentMarker
)

Use Builder#setCommentMarker(Character)

Returns:

A new CSVFormat that is equal to this with the specified character as a delimiter
org.apache.commons.csv.CSVFormat.withDelimiter
(final char
the delimiter character
delimiter
)

Use Builder#setDelimiter(char)

Returns:

A new CSVFormat that is equal to this but with the specified character as the escape character
org.apache.commons.csv.CSVFormat.withEscape
(final char
the escape character
escape
)

Use Builder#setEscape(char)

Returns:

A new CSVFormat that is equal to this but with the specified character as the escape character
org.apache.commons.csv.CSVFormat.withEscape
(final Character
the escape character, use null to disable
escape
)

Use Builder#setEscape(Character)

Returns:

A new CSVFormat that is equal to this but using the first record as header.
org.apache.commons.csv.CSVFormat.withFirstRecordAsHeader
()

Use Builder#setHeader().setSkipHeaderRecord(true).

Returns:

A new CSVFormat that is equal to this but with the specified header
org.apache.commons.csv.CSVFormat.withHeader
(final Class<? extends Enum<?>>
the enum defining the header, null if disabled, empty if parsed automatically, user specified otherwise.
headerEnum
)

Use Builder#setHeader(Class)

Returns:

A new CSVFormat that is equal to this but with the specified header
org.apache.commons.csv.CSVFormat.withHeader
(final ResultSet
the resultSet for the header, null if disabled, empty if parsed automatically, user-specified otherwise.
resultSet
)

Use Builder#setHeader(ResultSet)

Returns:

A new CSVFormat that is equal to this but with the specified header
org.apache.commons.csv.CSVFormat.withHeader
(final ResultSetMetaData
the metaData for the header, null if disabled, empty if parsed automatically, user specified otherwise.
resultSetMetaData
)

Use Builder#setHeader(ResultSetMetaData)

Returns:

A new CSVFormat that is equal to this but with the specified header
org.apache.commons.csv.CSVFormat.withHeader
(final String...
the header, null if disabled, empty if parsed automatically, user-specified otherwise.
header
)

Use Builder#setHeader(String...)

Returns:

A new CSVFormat that is equal to this but with the specified header
org.apache.commons.csv.CSVFormat.withHeaderComments
(final Object...
the headerComments which will be printed by the Printer before the actual CSV data.
headerComments
)

Use Builder#setHeaderComments(Object...)

Returns:

A new CSVFormat that is equal to this but with the specified empty line skipping behavior.
org.apache.commons.csv.CSVFormat.withIgnoreEmptyLines
()

Use Builder#setIgnoreEmptyLines(true)

Returns:

A new CSVFormat that is equal to this but with the specified empty line skipping behavior.
org.apache.commons.csv.CSVFormat.withIgnoreEmptyLines
(final boolean
the empty line skipping behavior, true to ignore the empty lines between the records, false to translate empty lines to empty records.
ignoreEmptyLines
)

Use Builder#setIgnoreEmptyLines(boolean)

Returns:

A new CSVFormat that will ignore the new case header name behavior.
org.apache.commons.csv.CSVFormat.withIgnoreHeaderCase
()

Use Builder#setIgnoreHeaderCase(true)

Returns:

A new CSVFormat that will ignore case header name if specified as true
org.apache.commons.csv.CSVFormat.withIgnoreHeaderCase
(final boolean
the case mapping behavior, true to access name/values, false to leave the mapping as is.
ignoreHeaderCase
)

Use Builder#setIgnoreHeaderCase(boolean)

Returns:

A new CSVFormat that is equal to this but with the specified parser trimming behavior.
org.apache.commons.csv.CSVFormat.withIgnoreSurroundingSpaces
()

Use Builder#setIgnoreSurroundingSpaces(true)

Returns:

A new CSVFormat that is equal to this but with the specified trimming behavior.
org.apache.commons.csv.CSVFormat.withIgnoreSurroundingSpaces
(final boolean
the parser trimming behavior, true to remove the surrounding spaces, false to leave the spaces as is.
ignoreSurroundingSpaces
)

Use Builder#setIgnoreSurroundingSpaces(boolean)

Returns:

A new CSVFormat that is equal to this but with the specified null conversion string.
org.apache.commons.csv.CSVFormat.withNullString
(final String
the String to convert to and from null. No substitution occurs if null
nullString
)

Use Builder#setNullString(String)

Returns:

A new CSVFormat that is equal to this but with the specified character as quoteChar
org.apache.commons.csv.CSVFormat.withQuote
(final char
the quote character
quoteChar
)

Use Builder#setQuote(char)

Returns:

A new CSVFormat that is equal to this but with the specified character as quoteChar
org.apache.commons.csv.CSVFormat.withQuote
(final Character
the quote character, use null to disable.
quoteChar
)

Use Builder#setQuote(Character)

Returns:

A new CSVFormat that is equal to this but with the specified quote policy
org.apache.commons.csv.CSVFormat.withQuoteMode
(final QuoteMode
the quote policy to use for output.
quoteMode
)

Use Builder#setQuoteMode(QuoteMode)

Returns:

A new CSVFormat that is equal to this but with the specified output record separator
org.apache.commons.csv.CSVFormat.withRecordSeparator
(final char
the record separator to use for output.
recordSeparator
)

Use Builder#setRecordSeparator(char)

Returns:

A new CSVFormat that is equal to this but with the specified output record separator
org.apache.commons.csv.CSVFormat.withRecordSeparator
(final String
the record separator to use for output.
recordSeparator
)

Use Builder#setRecordSeparator(String)

Returns:

A new CSVFormat that is equal to this but with the specified skipHeaderRecord setting.
org.apache.commons.csv.CSVFormat.withSkipHeaderRecord
()

Use Builder#setSkipHeaderRecord(true)

Returns:

A new CSVFormat that is equal to this but with the specified skipHeaderRecord setting.
org.apache.commons.csv.CSVFormat.withSkipHeaderRecord
(final boolean
whether to skip the header record.
skipHeaderRecord
)

Use Builder#setSkipHeaderRecord(boolean)

Returns:

A new CSVFormat that is equal to this but with the operating system's line separator string.
org.apache.commons.csv.CSVFormat.withSystemRecordSeparator
()

Use setRecordSeparator(System.lineSeparator())

Returns:

A new CSVFormat that is equal to this but with the trailing delimiter setting.
org.apache.commons.csv.CSVFormat.withTrailingDelimiter
()

Use Builder#setTrailingDelimiter(true)

Returns:

A new CSVFormat that is equal to this but with the specified trailing delimiter setting.
org.apache.commons.csv.CSVFormat.withTrailingDelimiter
(final boolean
whether to add a trailing delimiter.
trailingDelimiter
)

Use Builder#setTrailingDelimiter(boolean)

Returns:

A new CSVFormat that is equal to this but with the trim setting on.
org.apache.commons.csv.CSVFormat.withTrim
()

Use Builder#setTrim(true)

Returns:

A new CSVFormat that is equal to this but with the specified trim setting.
org.apache.commons.csv.CSVFormat.withTrim
(final boolean
whether to trim leading and trailing blanks.
trim
)

Use Builder#setTrim(boolean)

org.apache.commons.csv.CSVParser(final Reader
a Reader containing CSV-formatted input. Must not be null.
reader
,
final CSVFormat
the CSVFormat used for CSV parsing. Must not be null.
format
)

Will be removed in the next major version, use Builder#get().

org.apache.commons.csv.CSVParser(final Reader
a Reader containing CSV-formatted input. Must not be null.
reader
,
final CSVFormat
the CSVFormat used for CSV parsing. Must not be null.
format
,
final long
Lexer offset when the parser does not start parsing at the beginning of the source.
characterOffset
,
final long
The next record number to assign.
recordNumber
)

Will be removed in the next major version, use Builder#get().

No API in this release references deprecated elements.