org.embulk.util.csv

Class CsvTokenizer.Builder

java.lang.Object

org.embulk.util.csv.CsvTokenizer.Builder

Enclosing class:

CsvTokenizer

public static class CsvTokenizer.Builder
extends Object

A builder of CsvTokenizer.

Method Summary

Modifier and Type	Method and Description
CsvTokenizer.Builder	acceptStrayQuotesAssumingNoDelimitersInFields() Sets to accept "stray quotes" under a special assumption that no delimiter character is included in fields.
CsvTokenizer	build(Iterator<String> iterator) Builds a CsvTokenizer instancefrom this builder, with iteration of strings as comma-separated values (CSV).
CsvTokenizer.Builder	enableTrimIfNotQuoted() Enables trimming a space character ' ' only if the field is not quoted.
boolean	isAcceptingStrayQuotesAssumingNoDelimitersInFields() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
boolean	isEnabledTrimIfNotQuoted() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
CsvTokenizer.Builder	noEscape() Disables escaping.
CsvTokenizer.Builder	noQuote() Disables quoting.
String	peekCommentLineMarker() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
char	peekEscape() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
long	peekMaxQuotedFieldLength() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
String	peekNewline() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
String	peekNullString() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
char	peekQuote() Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.
CsvTokenizer.Builder	setCommentLineMarker(String commentLineMarker) Sets a marker string to indicate that a line is commented-out.
CsvTokenizer.Builder	setEscape(char escape) Enables escaping, and sets a character for escaping.
CsvTokenizer.Builder	setMaxQuotedFieldLength(long maxQuotedFieldLength) Sets the maximum length of quoted fields.
CsvTokenizer.Builder	setNewline(String newline) Sets a string to take place in a column value string tokenized from a quoted field containing an end-of-line.
CsvTokenizer.Builder	setNullString(String nullString) Sets a special string in the CSV that is considered as null.
CsvTokenizer.Builder	setQuote(char quote) Enables quoting, and sets a character for quoting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

peekQuote

@Deprecated
public char peekQuote()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns the character for quoting.

Returns:

the character for quoting

setQuote

public CsvTokenizer.Builder setQuote(char quote)

Enables quoting, and sets a character for quoting.

Parameters:

quote - a character for quoting

Returns:

this builder

noQuote

public CsvTokenizer.Builder noQuote()

Disables quoting.

Returns:

this builder

peekEscape

@Deprecated
public char peekEscape()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns the character for escaping.

Returns:

the character for escaping

setEscape

public CsvTokenizer.Builder setEscape(char escape)

Enables escaping, and sets a character for escaping.

Parameters:

escape - a character for escaping

Returns:

this builder

noEscape

public CsvTokenizer.Builder noEscape()

Disables escaping.

Returns:

this builder

peekNewline

@Deprecated
public String peekNewline()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns the string to take place in a column value string tokenized from a quoted field containing an end-of-line.

Returns:

the string to take place in a column value string tokenized from a quoted field containing an end-of-line

setNewline

public CsvTokenizer.Builder setNewline(String newline)

Sets a string to take place in a column value string tokenized from a quoted field containing an end-of-line.

Parameters:

newline - a newline string that is one of "\r\n", "\r", or "\n".

Returns:

this builder

Throws:

NullPointerException - if newline is null

IllegalArgumentException - if newline is invalid

isEnabledTrimIfNotQuoted

@Deprecated
public boolean isEnabledTrimIfNotQuoted()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns true if enabled to trim a space character ' ' only if the field is not quoted, or false otherwise.

Returns:

true if enabled to trim a space character ' ' only if the field is not quoted, or false otherwise

enableTrimIfNotQuoted

public CsvTokenizer.Builder enableTrimIfNotQuoted()

Enables trimming a space character ' ' only if the field is not quoted.

Returns:

this builder

isAcceptingStrayQuotesAssumingNoDelimitersInFields

@Deprecated
public boolean isAcceptingStrayQuotesAssumingNoDelimitersInFields()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns true if it accepts "stray quotes" under a special assumption that no delimiter character is included in fields, or false otherwise.

Returns:

true if it accepts "stray quotes" under a special assumption that no delimiter character is included in fields, or false otherwise

acceptStrayQuotesAssumingNoDelimitersInFields

public CsvTokenizer.Builder acceptStrayQuotesAssumingNoDelimitersInFields()

Sets to accept "stray quotes" under a special assumption that no delimiter character is included in fields.

Returns:

this builder

peekMaxQuotedFieldLength

@Deprecated
public long peekMaxQuotedFieldLength()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns the maximum length of quoted fields.

Returns:

the maximum length of quoted fields

setMaxQuotedFieldLength

public CsvTokenizer.Builder setMaxQuotedFieldLength(long maxQuotedFieldLength)

Sets the maximum length of quoted fields.

Parameters:

maxQuotedFieldLength - the maximum length of quoted fields

Returns:

this builder

peekCommentLineMarker

@Deprecated
public String peekCommentLineMarker()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns the marker string to indicate that a line is commented-out.

Returns:

the marker string to indicate that a line is commented-out

setCommentLineMarker

public CsvTokenizer.Builder setCommentLineMarker(String commentLineMarker)

Sets a marker string to indicate that a line is commented-out.

Parameters:

commentLineMarker - a marker string to indicate that a line is commented-out (ex. "#", "//")

Returns:

this builder

peekNullString

@Deprecated
public String peekNullString()

Deprecated. Use this method only for purpose of testing. No guarantees to be maintained.

Returns the special string in the CSV that is considered as null.

Returns:

the special string in the CSV that is considered as null

setNullString

public CsvTokenizer.Builder setNullString(String nullString)

Sets a special string in the CSV that is considered as null.

Parameters:

nullString - a special string in the CSV that is considered as null (ex. "NULL")

Returns:

this builder

build

public CsvTokenizer build(Iterator<String> iterator)

Builds a CsvTokenizer instancefrom this builder, with iteration of strings as comma-separated values (CSV).

Parameters:

iterator - iteration of strings as comma-separated values (CSV)

Returns:

a new CsvTokenizer instance

Throws:

IllegalStateException - if the builder is configured with an invalid combination