org.josef.util.csv

Class AbstractCsv

java.lang.Object

org.josef.util.csv.AbstractCsv

Direct Known Subclasses:

AbstractCsvReader, AbstractCsvWriter

@Status(stage=DEVELOPMENT,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",at="2009-09-28") @Review(by="Kees Schotanus",at="2010-10-22",reason="Totally rewrote csv classes")
public abstract class AbstractCsv
extends Object

Abstract base class for Utility classes that read or write Comma Separated Values (csv).

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCsv() Default constructor that will use a comma as the column separator and the platform's line.separator as a row separator.
	AbstractCsv(Character columnSeparator) Constructs this AbstractCsv that will use the supplied columnSeparator as a column separator and the platform's line.separator as a row separator.
	AbstractCsv(Character columnSeparator, String rowSeparator) Constructs this AbstractCsv that will use the supplied columnSeparator as a column separator and the supplied rowSeparator as a row separator.

Method Summary

Modifier and Type	Method and Description
Character	getColumnSeparator() Gets the column separator.
abstract String[]	getNextRow() Gets the next row of columns.
String	getRowSeparator() Gets the row separator.
void	setColumnSeparator(Character columnSeparator) Sets the separator that will be used to separate the individual columns.
void	setRowSeparator(String rowSeparator) Sets the separator that will be used to separate the individual rows.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCsv

protected AbstractCsv()

Default constructor that will use a comma as the column separator and the platform's line.separator as a row separator.

AbstractCsv

public AbstractCsv(Character columnSeparator)

Constructs this AbstractCsv that will use the supplied columnSeparator as a column separator and the platform's line.separator as a row separator.

Parameters:

columnSeparator - The separator that separates the different columns.

Throws:

NullPointerException - When the supplied columnSeparator is null.

AbstractCsv

public AbstractCsv(Character columnSeparator,
                   String rowSeparator)

Constructs this AbstractCsv that will use the supplied columnSeparator as a column separator and the supplied rowSeparator as a row separator.

Parameters:

columnSeparator - The separator that separates the different columns.

rowSeparator - The separator that separates the different rows.

Throws:

NullPointerException - When either the supplied columnSeparator or rowSeparator is null.

Method Detail

getColumnSeparator

public Character getColumnSeparator()

Gets the column separator.

Returns:

The column separator.

setColumnSeparator

public void setColumnSeparator(Character columnSeparator)

Sets the separator that will be used to separate the individual columns.

Parameters:

columnSeparator - The separator that will be used to separate the individual columns.

Throws:

NullPointerException - When the supplied columnSeparator is null.

getRowSeparator

public String getRowSeparator()

Gets the row separator.

Returns:

The row separator.

setRowSeparator

public void setRowSeparator(String rowSeparator)

Sets the separator that will be used to separate the individual rows.

Parameters:

rowSeparator - The separator that will be used to separate the rows.
You will normally want to use the line separator used by the current operating system (which is the default).
Note: No check is made whether this separator differs from the column separator or the column separator is part of this separator but I can guarantee problems when this is the case.

Throws:

NullPointerException - When the supplied rowSeparator is null.

getNextRow

public abstract String[] getNextRow()

Gets the next row of columns.

Returns:

The next row of columns or null when no more rows exist.

Throws:

CsvException - When the next row could not be read or when this method is called after it has returned null.