Package org.bufio

Class CsvScanner

java.lang.Object

org.bufio.Scanner<T>

org.bufio.AbstractCsvScanner<String>

org.bufio.CsvScanner

All Implemented Interfaces:

Closeable, AutoCloseable, CharSequence, Iterable<String>

public class CsvScanner
extends AbstractCsvScanner<String>
implements Iterable<String>

Provides an interface for reading CSV data by field (compatible with rfc4180 and extended with the option of having a separator other than ","). Successive calls to the `scan` method will step through the 'fields', skipping the separator/newline between the fields. The `atEndOfRow` method tells when a field is terminated by a line break.

 CsvScanner s;
 while (s.scan())) {
   String value = s.value();
   // ...
   if (s.atEndOfRow()) {
     // ...
   }
 }
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Iterator<String>	iterator()	Iterates on fields.
protected String	newToken(char[] data, int start, int end)
boolean	scanBool(String trueValue)	Reads bool until next separator or eol/eof.
char	scanChar()	Reads char until next separator or eol/eof.
double	scanDouble()	Reads double until next separator or eol/eof.
float	scanFloat()	Reads float until next separator or eol/eof.
int	scanInt()	Reads int until next separator or eol/eof.
long	scanLong()	Reads long until next separator or eol/eof.
int	scanRow(String[] values)	Extra fields are skipped (when the number of fields is greater than `values` size).
String	scanText()	Reads text until next separator or eol/eof.
String	value()	Returns the most recent value generated by a call to scan.

Methods inherited from class org.bufio.AbstractCsvScanner

atEndOfRow, column, init, lineno, reset, setCommentMarker, setSkipEmptyLines, setTrim, skipRows

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from class org.bufio.Scanner

advance, atEndOfFile, charAt, close, length, peek, position, scan, setSplitFunc, subSequence, token, toString

Constructor Detail

CsvScanner

public CsvScanner(@WillCloseWhenClosed @Nonnull
                  Reader r)

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

CsvScanner

public CsvScanner(@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

newToken

protected String newToken(@Nonnull
                          char[] data,
                          @Nonnegative
                          int start,
                          @Nonnegative
                          int end)

Specified by:

newToken in class AbstractCsvScanner<String>

scanRow

@Nonnegative
public int scanRow(@Nonnull
                   String[] values)
            throws IOException

Extra fields are skipped (when the number of fields is greater than `values` size). Returns the number of values read (see AbstractCsvScanner.column). At EOF, returns 0.

 CsvScanner s;
 String[] values = new String[20]; // max columns
 int n;
 while ((n = s.scanRow(values)) > 0) {
   String[] row = Arrays.copyOf(values, n);
   // ...
 }
 

Throws:

IOException

value

public String value()

Returns the most recent value generated by a call to scan.

scanText

@Nullable
public String scanText()
                throws IOException

Reads text until next separator or eol/eof.

Throws:

IOException

scanDouble

public double scanDouble()
                  throws IOException,
                         NumberFormatException

Reads double until next separator or eol/eof.

Throws:

IOException

NumberFormatException

scanFloat

public float scanFloat()
                throws IOException,
                       NumberFormatException

Reads float until next separator or eol/eof.

Throws:

IOException

NumberFormatException

scanInt

public int scanInt()
            throws IOException,
                   NumberFormatException

Reads int until next separator or eol/eof.

Throws:

IOException

NumberFormatException

scanLong

public long scanLong()
              throws IOException,
                     NumberFormatException

Reads long until next separator or eol/eof.

Throws:

IOException

NumberFormatException

scanBool

public boolean scanBool(@Nonnull
                        String trueValue)
                 throws IOException

Reads bool until next separator or eol/eof.

Throws:

IOException

scanChar

public char scanChar()
              throws IOException,
                     IllegalArgumentException

Reads char until next separator or eol/eof.

Throws:

IOException

IllegalArgumentException

iterator

@Nonnull
public Iterator<String> iterator()

Iterates on fields. Stops at the end of the line/record.

 CsvScanner s;
 while (!s.atEndOfFile())) {
   for (String field : s) {
     // ...
   }
 }
 

Specified by:

iterator in interface Iterable<String>

Returns:

an iterator on fields.

Throws:

IllegalStateException - for IOException.