Class CSVFormat.Builder
- java.lang.Object
-
- org.apache.commons.csv.CSVFormat.Builder
-
- Enclosing class:
- CSVFormat
public static class CSVFormat.Builder extends java.lang.Object
Builds CSVFormat instances.- Since:
- 1.9.0
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowMissingColumnNames
private boolean
autoFlush
private java.lang.Character
commentMarker
private java.lang.String
delimiter
private DuplicateHeaderMode
duplicateHeaderMode
private java.lang.Character
escapeCharacter
private java.lang.String[]
headerComments
private java.lang.String[]
headers
private boolean
ignoreEmptyLines
private boolean
ignoreHeaderCase
private boolean
ignoreSurroundingSpaces
private boolean
lenientEof
private java.lang.String
nullString
private java.lang.Character
quoteCharacter
private java.lang.String
quotedNullString
private QuoteMode
quoteMode
private java.lang.String
recordSeparator
private boolean
skipHeaderRecord
private boolean
trailingData
private boolean
trailingDelimiter
private boolean
trim
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CSVFormat
build()
Builds a new CSVFormat instance.static CSVFormat.Builder
create()
Creates a new default builder.static CSVFormat.Builder
create(CSVFormat csvFormat)
Creates a new builder for the given format.CSVFormat.Builder
setAllowDuplicateHeaderNames(boolean allowDuplicateHeaderNames)
Deprecated.CSVFormat.Builder
setAllowMissingColumnNames(boolean allowMissingColumnNames)
Sets the parser missing column names behavior,true
to allow missing column names in the header line,false
to cause anIllegalArgumentException
to be thrown.CSVFormat.Builder
setAutoFlush(boolean autoFlush)
Sets whether to flush on close.CSVFormat.Builder
setCommentMarker(char commentMarker)
Sets the comment marker character, usenull
to disable comments.CSVFormat.Builder
setCommentMarker(java.lang.Character commentMarker)
Sets the comment marker character, usenull
to disable comments.CSVFormat.Builder
setDelimiter(char delimiter)
Sets the delimiter character.CSVFormat.Builder
setDelimiter(java.lang.String delimiter)
Sets the delimiter character.CSVFormat.Builder
setDuplicateHeaderMode(DuplicateHeaderMode duplicateHeaderMode)
Sets the duplicate header names behavior.CSVFormat.Builder
setEscape(char escapeCharacter)
Sets the escape character.CSVFormat.Builder
setEscape(java.lang.Character escapeCharacter)
Sets the escape character.CSVFormat.Builder
setHeader(java.lang.Class<? extends java.lang.Enum<?>> headerEnum)
Sets the header defined by the givenEnum
class.CSVFormat.Builder
setHeader(java.lang.String... header)
Sets the header to the given values.CSVFormat.Builder
setHeader(java.sql.ResultSet resultSet)
Sets the header from the result set metadata.CSVFormat.Builder
setHeader(java.sql.ResultSetMetaData resultSetMetaData)
Sets the header from the result set metadata.CSVFormat.Builder
setHeaderComments(java.lang.Object... headerComments)
Sets the header comments to write before the CSV data.CSVFormat.Builder
setHeaderComments(java.lang.String... headerComments)
Sets the header comments to write before the CSV data.CSVFormat.Builder
setIgnoreEmptyLines(boolean ignoreEmptyLines)
Sets the empty line skipping behavior,true
to ignore the empty lines between the records,false
to translate empty lines to empty records.CSVFormat.Builder
setIgnoreHeaderCase(boolean ignoreHeaderCase)
Sets the parser case mapping behavior,true
to access name/values,false
to leave the mapping as is.CSVFormat.Builder
setIgnoreSurroundingSpaces(boolean ignoreSurroundingSpaces)
Sets the parser trimming behavior,true
to remove the surrounding spaces,false
to leave the spaces as is.CSVFormat.Builder
setLenientEof(boolean lenientEof)
Sets whether reading end-of-file is allowed even when input is malformed, helps Excel compatibility.CSVFormat.Builder
setNullString(java.lang.String nullString)
Sets the String to convert to and fromnull
.CSVFormat.Builder
setQuote(char quoteCharacter)
Sets the quote character.CSVFormat.Builder
setQuote(java.lang.Character quoteCharacter)
Sets the quote character, usenull
to disable.CSVFormat.Builder
setQuoteMode(QuoteMode quoteMode)
Sets the quote policy to use for output.CSVFormat.Builder
setRecordSeparator(char recordSeparator)
Sets the record separator to use for output.CSVFormat.Builder
setRecordSeparator(java.lang.String recordSeparator)
Sets the record separator to use for output.CSVFormat.Builder
setSkipHeaderRecord(boolean skipHeaderRecord)
Sets whether to skip the header record.CSVFormat.Builder
setTrailingData(boolean trailingData)
Sets whether reading trailing data is allowed in records, helps Excel compatibility.CSVFormat.Builder
setTrailingDelimiter(boolean trailingDelimiter)
Sets whether to add a trailing delimiter.CSVFormat.Builder
setTrim(boolean trim)
Sets whether to trim leading and trailing blanks.
-
-
-
Field Detail
-
allowMissingColumnNames
private boolean allowMissingColumnNames
-
autoFlush
private boolean autoFlush
-
commentMarker
private java.lang.Character commentMarker
-
delimiter
private java.lang.String delimiter
-
duplicateHeaderMode
private DuplicateHeaderMode duplicateHeaderMode
-
escapeCharacter
private java.lang.Character escapeCharacter
-
headerComments
private java.lang.String[] headerComments
-
headers
private java.lang.String[] headers
-
ignoreEmptyLines
private boolean ignoreEmptyLines
-
ignoreHeaderCase
private boolean ignoreHeaderCase
-
ignoreSurroundingSpaces
private boolean ignoreSurroundingSpaces
-
nullString
private java.lang.String nullString
-
quoteCharacter
private java.lang.Character quoteCharacter
-
quotedNullString
private java.lang.String quotedNullString
-
quoteMode
private QuoteMode quoteMode
-
recordSeparator
private java.lang.String recordSeparator
-
skipHeaderRecord
private boolean skipHeaderRecord
-
lenientEof
private boolean lenientEof
-
trailingData
private boolean trailingData
-
trailingDelimiter
private boolean trailingDelimiter
-
trim
private boolean trim
-
-
Constructor Detail
-
Builder
private Builder(CSVFormat csvFormat)
-
-
Method Detail
-
create
public static CSVFormat.Builder create()
Creates a new default builder.- Returns:
- a copy of the builder
-
create
public static CSVFormat.Builder create(CSVFormat csvFormat)
Creates a new builder for the given format.- Parameters:
csvFormat
- the source format.- Returns:
- a copy of the builder
-
build
public CSVFormat build()
Builds a new CSVFormat instance.- Returns:
- a new CSVFormat instance.
-
setAllowDuplicateHeaderNames
@Deprecated public CSVFormat.Builder setAllowDuplicateHeaderNames(boolean allowDuplicateHeaderNames)
Deprecated.Sets the duplicate header names behavior, true to allow, false to disallow.- Parameters:
allowDuplicateHeaderNames
- the duplicate header names behavior, true to allow, false to disallow.- Returns:
- This instance.
-
setAllowMissingColumnNames
public CSVFormat.Builder setAllowMissingColumnNames(boolean allowMissingColumnNames)
Sets the parser missing column names behavior,true
to allow missing column names in the header line,false
to cause anIllegalArgumentException
to be thrown.- Parameters:
allowMissingColumnNames
- the missing column names behavior,true
to allow missing column names in the header line,false
to cause anIllegalArgumentException
to be thrown.- Returns:
- This instance.
-
setAutoFlush
public CSVFormat.Builder setAutoFlush(boolean autoFlush)
Sets whether to flush on close.- Parameters:
autoFlush
- whether to flush on close.- Returns:
- This instance.
-
setCommentMarker
public CSVFormat.Builder setCommentMarker(char commentMarker)
Sets the comment marker character, usenull
to disable comments.The comment start character is only recognized at the start of a line.
Comments are printed first, before headers.
Use
setCommentMarker(char)
orsetCommentMarker(Character)
to set the comment marker written at the start of each comment line.If the comment marker is not set, then the header comments are ignored.
For example:
builder.setCommentMarker('#') .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
writes:
# Generated by Apache Commons CSV. # 1970-01-01T00:00:00Z
- Parameters:
commentMarker
- the comment start marker, usenull
to disable.- Returns:
- This instance.
- Throws:
java.lang.IllegalArgumentException
- thrown if the specified character is a line break
-
setCommentMarker
public CSVFormat.Builder setCommentMarker(java.lang.Character commentMarker)
Sets the comment marker character, usenull
to disable comments.The comment start character is only recognized at the start of a line.
Comments are printed first, before headers.
Use
setCommentMarker(char)
orsetCommentMarker(Character)
to set the comment marker written at the start of each comment line.If the comment marker is not set, then the header comments are ignored.
For example:
builder.setCommentMarker('#') .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
writes:
# Generated by Apache Commons CSV. # 1970-01-01T00:00:00Z
- Parameters:
commentMarker
- the comment start marker, usenull
to disable.- Returns:
- This instance.
- Throws:
java.lang.IllegalArgumentException
- thrown if the specified character is a line break
-
setDelimiter
public CSVFormat.Builder setDelimiter(char delimiter)
Sets the delimiter character.- Parameters:
delimiter
- the delimiter character.- Returns:
- This instance.
-
setDelimiter
public CSVFormat.Builder setDelimiter(java.lang.String delimiter)
Sets the delimiter character.- Parameters:
delimiter
- the delimiter character.- Returns:
- This instance.
-
setDuplicateHeaderMode
public CSVFormat.Builder setDuplicateHeaderMode(DuplicateHeaderMode duplicateHeaderMode)
Sets the duplicate header names behavior.- Parameters:
duplicateHeaderMode
- the duplicate header names behavior- Returns:
- This instance.
- Since:
- 1.10.0
-
setEscape
public CSVFormat.Builder setEscape(char escapeCharacter)
Sets the escape character.- Parameters:
escapeCharacter
- the escape character.- Returns:
- This instance.
- Throws:
java.lang.IllegalArgumentException
- thrown if the specified character is a line break
-
setEscape
public CSVFormat.Builder setEscape(java.lang.Character escapeCharacter)
Sets the escape character.- Parameters:
escapeCharacter
- the escape character.- Returns:
- This instance.
- Throws:
java.lang.IllegalArgumentException
- thrown if the specified character is a line break
-
setHeader
public CSVFormat.Builder setHeader(java.lang.Class<? extends java.lang.Enum<?>> headerEnum)
Sets the header defined by the givenEnum
class.Example:
public enum HeaderEnum { Name, Email, Phone } Builder builder = builder.setHeader(HeaderEnum.class);
The header is also used by the
CSVPrinter
.- Parameters:
headerEnum
- the enum defining the header,null
if disabled, empty if parsed automatically, user-specified otherwise.- Returns:
- This instance.
-
setHeader
public CSVFormat.Builder setHeader(java.sql.ResultSet resultSet) throws java.sql.SQLException
Sets the header from the result set metadata. The header can be parsed automatically from the input file with:builder.setHeader();
or specified manually with:builder.setHeader(resultSet);
The header is also used by the
CSVPrinter
.- Parameters:
resultSet
- the resultSet for the header,null
if disabled, empty if parsed automatically, user-specified otherwise.- Returns:
- This instance.
- Throws:
java.sql.SQLException
- SQLException if a database access error occurs or this method is called on a closed result set.
-
setHeader
public CSVFormat.Builder setHeader(java.sql.ResultSetMetaData resultSetMetaData) throws java.sql.SQLException
Sets the header from the result set metadata. The header can be parsed automatically from the input file with:builder.setHeader();
or specified manually with:builder.setHeader(resultSetMetaData);
The header is also used by the
CSVPrinter
.- Parameters:
resultSetMetaData
- the metaData for the header,null
if disabled, empty if parsed automatically, user-specified otherwise.- Returns:
- This instance.
- Throws:
java.sql.SQLException
- SQLException if a database access error occurs or this method is called on a closed result set.
-
setHeader
public CSVFormat.Builder setHeader(java.lang.String... header)
Sets the header to the given values. The header can be parsed automatically from the input file with:builder.setHeader();
or specified manually with:builder.setHeader("name", "email", "phone");
The header is also used by the
CSVPrinter
.- Parameters:
header
- the header,null
if disabled, empty if parsed automatically, user-specified otherwise.- Returns:
- This instance.
-
setHeaderComments
public CSVFormat.Builder setHeaderComments(java.lang.Object... headerComments)
Sets the header comments to write before the CSV data.This setting is ignored by the parser.
Comments are printed first, before headers.
Use
setCommentMarker(char)
orsetCommentMarker(Character)
to set the comment marker written at the start of each comment line.If the comment marker is not set, then the header comments are ignored.
For example:
builder.setCommentMarker('#') .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0));
writes:
# Generated by Apache Commons CSV. # 1970-01-01T00:00:00Z
- Parameters:
headerComments
- the headerComments which will be printed by the Printer before the CSV data.- Returns:
- This instance.
-
setHeaderComments
public CSVFormat.Builder setHeaderComments(java.lang.String... headerComments)
Sets the header comments to write before the CSV data.This setting is ignored by the parser.
Comments are printed first, before headers.
Use
setCommentMarker(char)
orsetCommentMarker(Character)
to set the comment marker written at the start of each comment line.If the comment marker is not set, then the header comments are ignored.
For example:
builder.setCommentMarker('#') .setHeaderComments("Generated by Apache Commons CSV", Instant.ofEpochMilli(0).toString());
writes:
# Generated by Apache Commons CSV. # 1970-01-01T00:00:00Z
- Parameters:
headerComments
- the headerComments which will be printed by the Printer before the CSV data.- Returns:
- This instance.
-
setIgnoreEmptyLines
public CSVFormat.Builder setIgnoreEmptyLines(boolean ignoreEmptyLines)
Sets the empty line skipping behavior,true
to ignore the empty lines between the records,false
to translate empty lines to empty records.- Parameters:
ignoreEmptyLines
- the empty line skipping behavior,true
to ignore the empty lines between the records,false
to translate empty lines to empty records.- Returns:
- This instance.
-
setIgnoreHeaderCase
public CSVFormat.Builder setIgnoreHeaderCase(boolean ignoreHeaderCase)
Sets the parser case mapping behavior,true
to access name/values,false
to leave the mapping as is.- Parameters:
ignoreHeaderCase
- the case mapping behavior,true
to access name/values,false
to leave the mapping as is.- Returns:
- This instance.
-
setIgnoreSurroundingSpaces
public CSVFormat.Builder setIgnoreSurroundingSpaces(boolean ignoreSurroundingSpaces)
Sets the parser trimming behavior,true
to remove the surrounding spaces,false
to leave the spaces as is.- Parameters:
ignoreSurroundingSpaces
- the parser trimming behavior,true
to remove the surrounding spaces,false
to leave the spaces as is.- Returns:
- This instance.
-
setLenientEof
public CSVFormat.Builder setLenientEof(boolean lenientEof)
Sets whether reading end-of-file is allowed even when input is malformed, helps Excel compatibility.- Parameters:
lenientEof
- whether reading end-of-file is allowed even when input is malformed, helps Excel compatibility.- Returns:
- This instance.
- Since:
- 1.11.0
-
setNullString
public CSVFormat.Builder setNullString(java.lang.String nullString)
Sets the String to convert to and fromnull
. No substitution occurs ifnull
.- Reading: Converts strings equal to the given
nullString
tonull
when reading records. - Writing: Writes
null
as the givennullString
when writing records.
- Parameters:
nullString
- the String to convert to and fromnull
. No substitution occurs ifnull
.- Returns:
- This instance.
- Reading: Converts strings equal to the given
-
setQuote
public CSVFormat.Builder setQuote(char quoteCharacter)
Sets the quote character.- Parameters:
quoteCharacter
- the quote character.- Returns:
- This instance.
-
setQuote
public CSVFormat.Builder setQuote(java.lang.Character quoteCharacter)
Sets the quote character, usenull
to disable.- Parameters:
quoteCharacter
- the quote character, usenull
to disable.- Returns:
- This instance.
-
setQuoteMode
public CSVFormat.Builder setQuoteMode(QuoteMode quoteMode)
Sets the quote policy to use for output.- Parameters:
quoteMode
- the quote policy to use for output.- Returns:
- This instance.
-
setRecordSeparator
public CSVFormat.Builder setRecordSeparator(char recordSeparator)
Sets the record separator to use for output.Note: This setting is only used during printing and does not affect parsing. Parsing currently only works for inputs with '\n', '\r' and "\r\n"
- Parameters:
recordSeparator
- the record separator to use for output.- Returns:
- This instance.
-
setRecordSeparator
public CSVFormat.Builder setRecordSeparator(java.lang.String recordSeparator)
Sets the record separator to use for output.Note: This setting is only used during printing and does not affect parsing. Parsing currently only works for inputs with '\n', '\r' and "\r\n"
- Parameters:
recordSeparator
- the record separator to use for output.- Returns:
- This instance.
-
setSkipHeaderRecord
public CSVFormat.Builder setSkipHeaderRecord(boolean skipHeaderRecord)
Sets whether to skip the header record.- Parameters:
skipHeaderRecord
- whether to skip the header record.- Returns:
- This instance.
-
setTrailingData
public CSVFormat.Builder setTrailingData(boolean trailingData)
Sets whether reading trailing data is allowed in records, helps Excel compatibility.- Parameters:
trailingData
- whether reading trailing data is allowed in records, helps Excel compatibility.- Returns:
- This instance.
- Since:
- 1.11.0
-
setTrailingDelimiter
public CSVFormat.Builder setTrailingDelimiter(boolean trailingDelimiter)
Sets whether to add a trailing delimiter.- Parameters:
trailingDelimiter
- whether to add a trailing delimiter.- Returns:
- This instance.
-
setTrim
public CSVFormat.Builder setTrim(boolean trim)
Sets whether to trim leading and trailing blanks.- Parameters:
trim
- whether to trim leading and trailing blanks.- Returns:
- This instance.
-
-