de.larssh.utils.text

Class Csv

java.lang.Object

de.larssh.utils.collection.ProxiedCollection<E>

de.larssh.utils.collection.ProxiedList<CsvRow>

de.larssh.utils.text.Csv

All Implemented Interfaces:

Iterable<CsvRow>, Collection<CsvRow>, List<CsvRow>

public class Csv
extends ProxiedList<CsvRow>

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Instances of this class can be marked unmodifiable using unmodifiable(). Afterwards applying modifying actions on that instance results in an UnsupportedOperationException.

Field Summary

Fields

Modifier and Type	Field and Description
static char	DEFAULT_ESCAPER The default CSV escape character
static char	DEFAULT_SEPARATOR The default CSV separator character

Constructor Summary

Constructors

Constructor and Description
Csv() This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.
Csv(char separator, char escaper) This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.
Csv(int initialCapacity) This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.
Csv(int initialCapacity, char separator, char escaper) This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.
Csv(List<? extends List<String>> data) This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.
Csv(List<? extends List<String>> data, char separator, char escaper) This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

Method Summary

Modifier and Type	Method and Description
boolean	add(CsvRow element)
void	add(int index, CsvRow element)
boolean	add(List<String> element) Adds the specified CSV row to the this CSV object.
boolean	addAll(Collection<? extends CsvRow> collection)
boolean	addAll(int index, Collection<? extends CsvRow> collection)
boolean	addAllList(Collection<? extends List<String>> collection) Adds all of the CSV rows in collection to this CSV object.
CsvRow	get(int index)
char	getEscaper() The instances CSV escape character
List<String>	getHeaders() Returns the headers of this CSV object.
char	getSeparator() The instances CSV separator character
boolean	isModifiable() Flag specifying if this instance can be modified
static Csv	parse(Reader reader, char separator, char escaper) Parses the CSV data given by reader, starting at the current position.
CsvRow	remove(int index)
CsvRow	set(int index, CsvRow element)
String	toString() Returns a valid CSV string representation of this object using the instances separator and escaper.
String	toString(char separator, char escaper) Returns a valid CSV string representation of this object using separator and escaper.
Csv	unmodifiable() Marks the CSV object as unmodifiable

Methods inherited from class de.larssh.utils.collection.ProxiedList

getWrappedForRead, getWrappedIfModifiable, indexOf, lastIndexOf, listIterator, listIterator, subList

Methods inherited from class de.larssh.utils.collection.ProxiedCollection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

DEFAULT_ESCAPER

public static final char DEFAULT_ESCAPER

The default CSV escape character

DEFAULT_SEPARATOR

public static final char DEFAULT_SEPARATOR

The default CSV separator character

Constructor Detail

Csv

public Csv()

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Csv

public Csv(char separator,
           char escaper)

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Parameters:

separator - the instances CSV separator character

escaper - the instances CSV escape character

Csv

public Csv(int initialCapacity)

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Parameters:

initialCapacity - an initial capacity of the internal list

Throws:

IllegalArgumentException - if the specified initial capacity is negative

Csv

public Csv(int initialCapacity,
           char separator,
           char escaper)

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Parameters:

initialCapacity - an initial capacity of the internal list

separator - the instances CSV separator character

escaper - the instances CSV escape character

Throws:

IllegalArgumentException - if the specified initial capacity is negative

Csv

public Csv(List<? extends List<String>> data)

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Parameters:

data - a collection containing CSV rows to be added

Csv

public Csv(List<? extends List<String>> data,
           char separator,
           char escaper)

This class represents CSV data, consisting of rows of values, implementing List<String> for convenience reasons.

The first row is referenced as header row and CsvRow instances allow to retrieve their values by the column's CSV header value.

Parameters:

data - a collection containing CSV rows to be added

separator - the instances CSV separator character

escaper - the instances CSV escape character

Method Detail

parse

public static Csv parse(Reader reader,
                        char separator,
                        char escaper)
                 throws IOException

Parses the CSV data given by reader, starting at the current position.

Parameters:

reader - a Reader as CSV data input

separator - the CSV separator character

escaper - the CSV escaping character

Returns:

an object representing the parsed CSV data

Throws:

IllegalArgumentException - on illegal separator or escaper value

IOException - if an I/O error occurs

add

public boolean add(@Nullable
                   CsvRow element)

Specified by:

add in interface Collection<CsvRow>

Specified by:

add in interface List<CsvRow>

Overrides:

add in class ProxiedCollection<CsvRow>

add

public boolean add(List<String> element)

Adds the specified CSV row to the this CSV object.

Parameters:

element - the CSV row to be added

Returns:

true

Throws:

UnsupportedOperationException - if this CSV object is unmodifiable

add

public void add(int index,
                @Nullable
                CsvRow element)

Specified by:

add in interface List<CsvRow>

Overrides:

add in class ProxiedList<CsvRow>

addAll

public boolean addAll(@Nullable
                      Collection<? extends CsvRow> collection)

Specified by:

addAll in interface Collection<CsvRow>

Specified by:

addAll in interface List<CsvRow>

Overrides:

addAll in class ProxiedCollection<CsvRow>

addAll

public boolean addAll(int index,
                      @Nullable
                      Collection<? extends CsvRow> collection)

Specified by:

addAll in interface List<CsvRow>

Overrides:

addAll in class ProxiedList<CsvRow>

addAllList

public boolean addAllList(Collection<? extends List<String>> collection)

Adds all of the CSV rows in collection to this CSV object.

The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies, that the behavior of this call is undefined if the specified collection is this CSV object, and this CSV object is non-empty.)

Parameters:

collection - the collection containing CSV rows to be added

Returns:

true if this CSV object changed as a result of the call, else false

Throws:

UnsupportedOperationException - if this CSV object is unmodifiable

get

@NonNull
public CsvRow get(int index)

Specified by:

get in interface List<CsvRow>

Overrides:

get in class ProxiedList<CsvRow>

getHeaders

public List<String> getHeaders()

Returns the headers of this CSV object. Headers are specified by the first row. If this CSV object is empty, an empty list is returned.

Returns:

the headers of this CSV object

remove

@NonNull
public CsvRow remove(int index)

Specified by:

remove in interface List<CsvRow>

Overrides:

remove in class ProxiedList<CsvRow>

set

@NonNull
public CsvRow set(int index,
                           @Nullable
                           CsvRow element)

Specified by:

set in interface List<CsvRow>

Overrides:

set in class ProxiedList<CsvRow>

toString

public String toString()

Returns a valid CSV string representation of this object using the instances separator and escaper.

Overrides:

toString in class ProxiedCollection<CsvRow>

Returns:

a valid CSV representation of this object using the instances separator and escaper

toString

public String toString(char separator,
                       char escaper)

Returns a valid CSV string representation of this object using separator and escaper.

This is a short-hand method for StringConverters.encodeCsv(Collection, char, char).

Parameters:

separator - the CSV separator

escaper - the CSV value escaper

Returns:

a valid CSV representation of this object using separator and escaper

unmodifiable

public Csv unmodifiable()

Marks the CSV object as unmodifiable

Returns:

this objects

getSeparator

public char getSeparator()

The instances CSV separator character

Returns:

the CSV separator character

getEscaper

public char getEscaper()

The instances CSV escape character

Returns:

the CSV escape character

isModifiable

public boolean isModifiable()

Flag specifying if this instance can be modified

Specified by:

isModifiable in class ProxiedCollection<CsvRow>

Returns:

true if this instance is modifiable, else false