org.spf4j.io.csv

Interface CsvReader

public interface CsvReader

Char separated value file Reader. A newly created reader will initially be positioned at START_DOCUMENT. (current()) A example Token sequence will be: START_DOCUMENT, ELEMENT, ELEMENT, END_ROW, ELEMENT, ELEMENT, END_ROW, END_DOCUMENT

Author:

zoly

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CsvReader.TokenType

Method Summary

Modifier and Type	Method and Description
CsvReader.TokenType	current()
long	currentLineNumber() Current CSV line number.
CharSequence	getElement() the CSV element string.
CsvReader.TokenType	next() read next CSV element, and return its type.
default void	readRow(Consumer<CharSequence> consumer)
default int	skipRow()
static CsvReader	toReader(Iterator<? extends CharSequence> it)

Method Detail

next

@Nonnull
CsvReader.TokenType next()
                           throws IOException,
                                  CsvParseException

read next CSV element, and return its type.

Returns:

return CSV element type.

Throws:

IOException - exception is something goes wrong.

CsvParseException

current

@Nonnull
CsvReader.TokenType current()

Returns:

the currently parsed token type, null if no current token is available (next has never been called)

Throws:

IOException

CsvParseException

getElement

CharSequence getElement()

the CSV element string. the underlying instance is reused, so you will need to make a copy of this if planning to use it.

Returns:

CharSequence representing a csv cell.

currentLineNumber

long currentLineNumber()

Current CSV line number.

Returns:

skipRow

default int skipRow()
             throws IOException,
                    CsvParseException

Throws:

IOException

CsvParseException

readRow

default void readRow(Consumer<CharSequence> consumer)
              throws IOException,
                     CsvParseException

Throws:

IOException

CsvParseException

toReader

static CsvReader toReader(Iterator<? extends CharSequence> it)