com.fasterxml.jackson.dataformat.csv

Class CsvSchema.Builder

java.lang.Object

com.fasterxml.jackson.dataformat.csv.CsvSchema.Builder

Enclosing class:

CsvSchema

public static class CsvSchema.Builder
extends Object

Class used for building CsvSchema instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_arrayElementSeparator
protected ArrayList<CsvSchema.Column>	_columns
protected char	_columnSeparator
protected int	_escapeChar
protected int	_features Bitflag for general-purpose on/off features.
protected char[]	_lineSeparator
protected char[]	_nullValue
protected int	_quoteChar

Constructor Summary

Constructors

Constructor and Description
CsvSchema.Builder()
CsvSchema.Builder(CsvSchema src) "Copy" constructor which creates builder that has settings of given source schema

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_checkIndex(int index)
protected void	_feature(int feature, boolean state)
CsvSchema.Builder	addArrayColumn(String name)
CsvSchema.Builder	addArrayColumn(String name, int elementSeparator)
CsvSchema.Builder	addBooleanColumn(String name)
CsvSchema.Builder	addColumn(CsvSchema.Column c)
CsvSchema.Builder	addColumn(String name)
CsvSchema.Builder	addColumn(String name, CsvSchema.ColumnType type)
CsvSchema.Builder	addNumberColumn(String name)
CsvSchema	build()
CsvSchema.Builder	clearColumns()
CsvSchema.Builder	disableElementSeparator(char c)
CsvSchema.Builder	disableEscapeChar() Method for specifying that no escape character is to be used with CSV documents this schema defines.
CsvSchema.Builder	disableQuoteChar()
Iterator<CsvSchema.Column>	getColumns()
void	removeArrayElementSeparator(int index)
void	renameColumn(int index, String newName)
void	replaceColumn(int index, CsvSchema.Column c)
CsvSchema.Builder	setAllowComments(boolean b) Method for specifying whether Schema should indicate that "hash comments" (lines where the first non-whitespace character is '#') are allowed; if so, they will be skipped without processing.
CsvSchema.Builder	setArrayElementSeparator(char c)
void	setArrayElementSeparator(int index, char sep)
CsvSchema.Builder	setColumnSeparator(char c) Method for specifying character used to separate column values.
void	setColumnType(int index, CsvSchema.ColumnType type)
CsvSchema.Builder	setEscapeChar(char c) Method for specifying character used for optional escaping of characters in quoted String values.
CsvSchema.Builder	setLineSeparator(char lf)
CsvSchema.Builder	setLineSeparator(String lf)
CsvSchema.Builder	setNullValue(char[] nvl)
CsvSchema.Builder	setNullValue(String nvl)
CsvSchema.Builder	setQuoteChar(char c) Method for specifying character used for optional quoting of values.
CsvSchema.Builder	setSkipFirstDataRow(boolean b) Method for specifying whether Schema should indicate that the first line that is not a header (if header handling enabled) should be skipped in its entirety.
CsvSchema.Builder	setUseHeader(boolean b) Method for specifying whether Schema should indicate that a header line (first row that contains column names) is to be used for reading and writing or not.
int	size()

Methods inherited from class java.lang.Object

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

Field Detail

_columns

protected final ArrayList<CsvSchema.Column> _columns

_features

protected int _features

Bitflag for general-purpose on/off features.

Since:

2.5

_columnSeparator

protected char _columnSeparator

_arrayElementSeparator

protected int _arrayElementSeparator

_quoteChar

protected int _quoteChar

_escapeChar

protected int _escapeChar

_lineSeparator

protected char[] _lineSeparator

_nullValue

protected char[] _nullValue

Since:

2.5

Constructor Detail

CsvSchema.Builder

public CsvSchema.Builder()

CsvSchema.Builder

public CsvSchema.Builder(CsvSchema src)

"Copy" constructor which creates builder that has settings of given source schema

Method Detail

addColumn

public CsvSchema.Builder addColumn(String name)

addColumn

public CsvSchema.Builder addColumn(String name,
                          CsvSchema.ColumnType type)

addColumn

public CsvSchema.Builder addColumn(CsvSchema.Column c)

addArrayColumn

public CsvSchema.Builder addArrayColumn(String name)

addArrayColumn

public CsvSchema.Builder addArrayColumn(String name,
                               int elementSeparator)

addNumberColumn

public CsvSchema.Builder addNumberColumn(String name)

addBooleanColumn

public CsvSchema.Builder addBooleanColumn(String name)

replaceColumn

public void replaceColumn(int index,
                 CsvSchema.Column c)

renameColumn

public void renameColumn(int index,
                String newName)

setColumnType

public void setColumnType(int index,
                 CsvSchema.ColumnType type)

removeArrayElementSeparator

public void removeArrayElementSeparator(int index)

setArrayElementSeparator

public void setArrayElementSeparator(int index,
                            char sep)

clearColumns

public CsvSchema.Builder clearColumns()

size

public int size()

getColumns

public Iterator<CsvSchema.Column> getColumns()

setUseHeader

public CsvSchema.Builder setUseHeader(boolean b)

Method for specifying whether Schema should indicate that a header line (first row that contains column names) is to be used for reading and writing or not.

setSkipFirstDataRow

public CsvSchema.Builder setSkipFirstDataRow(boolean b)

Method for specifying whether Schema should indicate that the first line that is not a header (if header handling enabled) should be skipped in its entirety.

setAllowComments

public CsvSchema.Builder setAllowComments(boolean b)

Method for specifying whether Schema should indicate that "hash comments" (lines where the first non-whitespace character is '#') are allowed; if so, they will be skipped without processing.

Since:

2.5

_feature

protected final void _feature(int feature,
            boolean state)

setColumnSeparator

public CsvSchema.Builder setColumnSeparator(char c)

Method for specifying character used to separate column values. Default is comma (',').

setArrayElementSeparator

public CsvSchema.Builder setArrayElementSeparator(char c)

Since:

2.5

disableElementSeparator

public CsvSchema.Builder disableElementSeparator(char c)

Since:

2.5

setQuoteChar

public CsvSchema.Builder setQuoteChar(char c)

Method for specifying character used for optional quoting of values. Default is double-quote ('"').

disableQuoteChar

public CsvSchema.Builder disableQuoteChar()

Since:

2.4

setEscapeChar

public CsvSchema.Builder setEscapeChar(char c)

Method for specifying character used for optional escaping of characters in quoted String values. Default is "not used", meaning that no escaping used.

disableEscapeChar

public CsvSchema.Builder disableEscapeChar()

Method for specifying that no escape character is to be used with CSV documents this schema defines.

setLineSeparator

public CsvSchema.Builder setLineSeparator(String lf)

setLineSeparator

public CsvSchema.Builder setLineSeparator(char lf)

setNullValue

public CsvSchema.Builder setNullValue(String nvl)

setNullValue

public CsvSchema.Builder setNullValue(char[] nvl)

build

public CsvSchema build()

_checkIndex

protected void _checkIndex(int index)