Class CsvSchema.Column

java.lang.Object

com.fasterxml.jackson.dataformat.csv.CsvSchema.Column

All Implemented Interfaces:

Serializable

Enclosing class:

CsvSchema

public static class CsvSchema.Column
extends Object
implements Serializable

Representation of info for a single column

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	_arrayElementSeparator	NOTE: type changed from `char` to `java.lang.String` in 2.7
private final int	_index
private final String	_name
private final CsvSchema.Column	_next	Link to the next column within schema, if one exists; null for the last column.
private final CsvSchema.ColumnType	_type
private final CsvValueDecorator	_valueDecorator	Value decorator used for this column, if any; null if none.
static final CsvSchema.Column	PLACEHOLDER
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
	Column(int index, String name)
	Column(int index, String name, CsvSchema.ColumnType type)
	Column(int index, String name, CsvSchema.ColumnType type, String arrayElementSep)
protected	Column(CsvSchema.Column src, int index, CsvSchema.Column next)
protected	Column(CsvSchema.Column src, int index, CsvValueDecorator valueDecorator, CsvSchema.Column next)
	Column(CsvSchema.Column src, CsvSchema.Column next)
protected	Column(CsvSchema.Column src, CsvValueDecorator valueDecorator)

Method Summary

Modifier and Type	Method	Description
String	getArrayElementSeparator()
int	getIndex()
String	getName()
CsvSchema.Column	getNext()
CsvSchema.Column	getNextWithName(String name)	Access that returns same as getNext() iff name of that column is same as given name
CsvSchema.ColumnType	getType()
CsvValueDecorator	getValueDecorator()
boolean	hasName(String n)
boolean	isArray()
CsvSchema.Column	withArrayElementSeparator(String separator)
CsvSchema.Column	withName(String newName)
CsvSchema.Column	withNext(int index, CsvSchema.Column next)
CsvSchema.Column	withNext(CsvSchema.Column next)
CsvSchema.Column	withType(CsvSchema.ColumnType newType)
CsvSchema.Column	withValueDecorator(CsvValueDecorator valueDecorator)

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

PLACEHOLDER

public static final CsvSchema.Column PLACEHOLDER

_name

private final String _name

_index

private final int _index

_type

private final CsvSchema.ColumnType _type

_arrayElementSeparator

private final String _arrayElementSeparator

NOTE: type changed from `char` to `java.lang.String` in 2.7

Since:

2.5

_valueDecorator

private final CsvValueDecorator _valueDecorator

Value decorator used for this column, if any; null if none. Used to add decoration on serialization (writing) and remove decoration on deserialization (reading).

Since:

2.18

_next

private final CsvSchema.Column _next

Link to the next column within schema, if one exists; null for the last column.

Since:

2.6

Constructor Details

Column

public Column(int index,
 String name)

Column

public Column(int index,
 String name,
 CsvSchema.ColumnType type)

Column

public Column(int index,
 String name,
 CsvSchema.ColumnType type,
 String arrayElementSep)

Column

public Column(CsvSchema.Column src,
 CsvSchema.Column next)

Column

protected Column(CsvSchema.Column src,
 int index,
 CsvSchema.Column next)

Column

protected Column(CsvSchema.Column src,
 CsvValueDecorator valueDecorator)

Since:

2.18

Column

protected Column(CsvSchema.Column src,
 int index,
 CsvValueDecorator valueDecorator,
 CsvSchema.Column next)

Since:

2.18

Method Details

withName

public CsvSchema.Column withName(String newName)

withType

public CsvSchema.Column withType(CsvSchema.ColumnType newType)

withArrayElementSeparator

public CsvSchema.Column withArrayElementSeparator(String separator)

withValueDecorator

public CsvSchema.Column withValueDecorator(CsvValueDecorator valueDecorator)

Since:

2.18

withNext

public CsvSchema.Column withNext(CsvSchema.Column next)

withNext

public CsvSchema.Column withNext(int index,
 CsvSchema.Column next)

Since:

2.7

getIndex

public int getIndex()

getName

public String getName()

getType

public CsvSchema.ColumnType getType()

getNext

public CsvSchema.Column getNext()

getNextWithName

public CsvSchema.Column getNextWithName(String name)

Access that returns same as getNext() iff name of that column is same as given name

hasName

public boolean hasName(String n)

getArrayElementSeparator

public String getArrayElementSeparator()

Since:

2.5

getValueDecorator

public CsvValueDecorator getValueDecorator()

Since:

2.18

isArray

public boolean isArray()