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 ArrayList<CsvSchema.Column>	_columns
protected char	_columnSeparator
protected int	_escapeChar
protected char[]	_lineSeparator
protected int	_quoteChar
protected boolean	_skipFirstDataRow
protected boolean	_useHeader

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	_checkIndex(int index)
CsvSchema.Builder	addColumn(CsvSchema.Column c)
CsvSchema.Builder	addColumn(String name)
CsvSchema.Builder	addColumn(String name, CsvSchema.ColumnType type)
CsvSchema	build()
CsvSchema.Builder	clearColumns()
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	renameColumn(int index, String newName)
void	replaceColumn(int index, CsvSchema.Column c)
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	setQuoteChar(char c) Method for specifying character used for optional quoting of values.
CsvSchema.Builder	setSkipFirstDataRow(boolean b)
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

_useHeader

protected boolean _useHeader

_skipFirstDataRow

protected boolean _skipFirstDataRow

_columnSeparator

protected char _columnSeparator

_quoteChar

protected int _quoteChar

_escapeChar

protected int _escapeChar

_lineSeparator

protected char[] _lineSeparator

Constructor Detail

Builder

public Builder()

Builder

public 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)

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)

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)

setColumnSeparator

public CsvSchema.Builder setColumnSeparator(char c)

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

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)

build

public CsvSchema build()

_checkIndex

protected void _checkIndex(int index)