net.shredzone.jshred.util

Class CSVLine

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<String>

net.shredzone.jshred.util.CSVLine

All Implemented Interfaces:

Serializable, Cloneable, Iterable<String>, Collection<String>, List<String>, RandomAccess

public class CSVLine
extends ArrayList<String>

This class handles one CSV line.

If you pass a String, it will be split into several columns which are delimited by the delim character. It will take care for proper unquoting if a column was quoted.

You can also add and remove columns at will. The toString() method will result in a valid CSV line that can be written out.

The CSV format is: Each row ends with a newline. A row consists of one or more columns, each separated by a delimiter character. If one column contains the delimiter character, the entire column must be quoted in double quotes. If the column also contains the quote character, then the quote characters within the column must be doubled.

CSVLine inherits the List interface for easier access.

Author:

Richard "Shred" Körber

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
CSVLine() Creates a new, empty CSVLine with ';' as delimiter.
CSVLine(char delim) Creates a new, empty CSVLine with the given delimiter.
CSVLine(String text) Creates a new CSVLine, with the given text and ';' as default delimiter.
CSVLine(String text, char delim) Creates a new CSVLine with the given text and the given delimiter.

Method Summary

Modifier and Type	Method and Description
void	addLine(String text) Adds a CSV line to the current content.
char	getDelimiter() Gets the delimiter character.
void	setDelimiter(char delim) Sets the delimiter character.
String	toString() Gets a valid CSV line of the current content, using the current delimiter char.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

CSVLine

public CSVLine()

Creates a new, empty CSVLine with ';' as delimiter.

CSVLine

public CSVLine(char delim)

Creates a new, empty CSVLine with the given delimiter.

Parameters:

delim - Delimiter

CSVLine

public CSVLine(String text)

Creates a new CSVLine, with the given text and ';' as default delimiter.

Parameters:

text - Text to be split up

CSVLine

public CSVLine(String text,
               char delim)

Creates a new CSVLine with the given text and the given delimiter.

Parameters:

text - Text to be split up

delim - Delimiter character

Method Detail

addLine

public void addLine(String text)

Adds a CSV line to the current content. All columns are added to the end of the current column list. This is most probably not what you wanted to do!

If you want to use this class with a new line, use ArrayList.clear() before:

 csvline.clear();
 csvline.addLine(line);
 

Parameters:

text - Line to be added

setDelimiter

public void setDelimiter(char delim)

Sets the delimiter character. The quote character '"' is not allowed as a delimiter, and will throw an IllegalArgumentException.

Parameters:

delim - Delimiter

getDelimiter

public char getDelimiter()

Gets the delimiter character.

Returns:

Delimiter

toString

public String toString()

Gets a valid CSV line of the current content, using the current delimiter char.

Note: There is no newline character at the end of the line!

Overrides:

toString in class AbstractCollection<String>

Returns:

CSV line, without newline character