Package org.bufio

Class CsvReader

java.lang.Object

org.bufio.CsvReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String[]>

public class CsvReader
extends Object
implements Closeable, Iterable<String[]>

Provides an interface for reading CSV data by row (compatible with rfc4180 and extended with the option of having a separator other than ",").

 CsvReader r;
 while (r.next()) {
   String value1 = r.getString(1);
   // ...
 }
 

Constructor Summary

Constructors

Constructor	Description
CsvReader(Reader r)	Creates a "standard" CSV reader (separator is comma and quoted mode active)
CsvReader(Reader r, char sep, boolean quoted)	Returns a new CSV scanner to read from `r`.

Method Summary

Modifier and Type	Method	Description
void	close()
int	findColumn(String columnLabel)
byte	getByte(int columnIndex)
byte	getByte(String columnLabel)
int	getColumnCount()
String	getColumnLabel(int columnIndex)
double	getDouble(int columnIndex)
double	getDouble(String columnLabel)
float	getFloat(int columnIndex)
float	getFloat(String columnLabel)
int	getInt(int columnIndex)
int	getInt(String columnLabel)
long	getLong(int columnIndex)
long	getLong(String columnLabel)
<T> T	getObject(int columnIndex, Class<T> type)
<T> T	getObject(String columnLabel, Class<T> type)
int	getRow()	Returns current line number.
short	getShort(int columnIndex)
short	getShort(String columnLabel)
String	getString(int columnIndex)
String	getString(String columnLabel)
Iterator<String[]>	iterator()	Iterates on rows.
boolean	next()
void	reset(Reader r)	Reuse this component with a new content.
Map<String,Integer>	scanHeaders(boolean ignoreCommentMarker)
void	setCommentMarker(char comment)	Sets the character marking the start of a line comment.
void	setEmptyIsNull(boolean emptyIsNull)	Treats empty value as `null` value
void	setSkipEmptyLines(boolean skipEmptyLines)
void	setTrim(boolean trim)	Trims spaces (only on not-quoted values).
void	setUnmarshaler(Unmarshaler unmarshaler)	Sets the component used by getObject(int, java.lang.Class<T>) to transform text to object.
void	skipRows(int n)	Skips `n` rows
Stream<String[]>	stream()
String[]	values()
boolean	wasNull()	Reports whether the last column read had an empty value.
void	withHeaders(Iterable<String> headers)

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvReader

public CsvReader(@WillCloseWhenClosed @Nonnull
                 Reader r)

Creates a "standard" CSV reader (separator is comma and quoted mode active)

CsvReader

public CsvReader(@WillCloseWhenClosed @Nonnull
                 Reader r,
                 char sep,
                 boolean quoted)

Returns a new CSV scanner to read from `r`. When `quoted` is false, values must not contain a separator or newline.

Method Detail

reset

public final void reset(@WillCloseWhenClosed @Nonnull
                        Reader r)
                 throws IOException

Reuse this component with a new content.

Throws:

IOException

withHeaders

public void withHeaders(@Nonnull
                        Iterable<String> headers)

scanHeaders

@Nonnull
public Map<String,Integer> scanHeaders(boolean ignoreCommentMarker)
                                throws IOException

Throws:

IOException

next

public boolean next()
             throws IOException

Throws:

IOException

See Also:

ResultSet.next()

values

@Nonnull
public String[] values()

getString

@Nullable
public String getString(@Nonnegative
                        int columnIndex)
                 throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getString(int)

getString

public String getString(String columnLabel)
                 throws ScanException

Throws:

ScanException

See Also:

ResultSet.getString(String)

getByte

public byte getByte(@Nonnegative
                    int columnIndex)
             throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getByte(int)

getByte

public byte getByte(String columnLabel)
             throws ScanException

Throws:

ScanException

See Also:

ResultSet.getByte(String)

getShort

public short getShort(@Nonnegative
                      int columnIndex)
               throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getShort(int)

getShort

public short getShort(String columnLabel)
               throws ScanException

Throws:

ScanException

See Also:

ResultSet.getShort(String)

getInt

public int getInt(@Nonnegative
                  int columnIndex)
           throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getInt(int)

getInt

public int getInt(String columnLabel)
           throws ScanException

Throws:

ScanException

See Also:

ResultSet.getInt(String)

getLong

public long getLong(@Nonnegative
                    int columnIndex)
             throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getLong(int)

getLong

public long getLong(String columnLabel)
             throws ScanException

Throws:

ScanException

See Also:

ResultSet.getLong(String)

getFloat

public float getFloat(@Nonnegative
                      int columnIndex)
               throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getFloat(int)

getFloat

public float getFloat(String columnLabel)
               throws ScanException

Throws:

ScanException

See Also:

ResultSet.getFloat(String)

getDouble

public double getDouble(@Nonnegative
                        int columnIndex)
                 throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getDouble(int)

getDouble

public double getDouble(String columnLabel)
                 throws ScanException

Throws:

ScanException

See Also:

ResultSet.getDouble(String)

getObject

public <T> T getObject(@Nonnegative
                       int columnIndex,
                       Class<T> type)
                throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSet.getObject(int, Class)

getObject

public <T> T getObject(String columnLabel,
                       Class<T> type)
                throws ScanException

Throws:

ScanException

See Also:

ResultSet.getObject(String, Class)

findColumn

public int findColumn(String columnLabel)
               throws ScanException

Throws:

ScanException

See Also:

ResultSet.findColumn(String)

skipRows

public void skipRows(@Nonnegative
                     int n)
              throws IOException

Skips `n` rows

Throws:

IOException

getRow

@Nonnegative
public int getRow()

Returns current line number.

See Also:

ResultSet.getRow()

getColumnCount

@Nonnegative
public int getColumnCount()

See Also:

ResultSetMetaData.getColumnCount()

getColumnLabel

public String getColumnLabel(@Nonnegative
                             int columnIndex)
                      throws ScanException

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Throws:

ScanException

See Also:

ResultSetMetaData.getColumnLabel(int)

setCommentMarker

public void setCommentMarker(char comment)

Sets the character marking the start of a line comment. When specified (not 0), line comment appears as empty line.

setTrim

public void setTrim(boolean trim)

Trims spaces (only on not-quoted values). Break rfc4180 rule: "Spaces are considered part of a field and should not be ignored."

setSkipEmptyLines

public void setSkipEmptyLines(boolean skipEmptyLines)

setEmptyIsNull

public void setEmptyIsNull(boolean emptyIsNull)

Treats empty value as `null` value

wasNull

public boolean wasNull()

Reports whether the last column read had an empty value.

See Also:

ResultSet.wasNull()

setUnmarshaler

public void setUnmarshaler(@Nullable
                           Unmarshaler unmarshaler)

Sets the component used by getObject(int, java.lang.Class<T>) to transform text to object.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

iterator

@Nonnull
public Iterator<String[]> iterator()

Iterates on rows.

 CsvReader r;
 for (String[] row : r) {
   // ...
 }
 

Specified by:

iterator in interface Iterable<String[]>

Returns:

an iterator on rows.

Throws:

IllegalStateException - for IOException.

stream

@Nonnull
public Stream<String[]> stream()

Returns:

a sequential Stream over the elements in this reader.