Package com.puresoltechnologies.streaming.csv

Class CSVReader

java.lang.Object

com.puresoltechnologies.streaming.csv.CSVReader

All Implemented Interfaces:

StreamIterator<CSVRecord>, Iterator<CSVRecord>

public class CSVReader
extends Object
implements StreamIterator<CSVRecord>

This class provides an CSV reader. The default settings read the provided stream as RFC4180 (https://tools.ietf.org/html/rfc4180) compliant file.

Author:

Rick-Rainer Ludwig

Constructor Summary

Constructors

Constructor	Description
CSVReader(InputStream inputStream)
CSVReader(InputStream inputStream, boolean hasHeader)
CSVReader(InputStream inputStream, Charset charset)
CSVReader(InputStream inputStream, Charset charset, boolean hasHeader)

Method Summary

Modifier and Type	Method	Description
CSVHeader	getHeader()
boolean	hasNext()
CSVRecord	next()	This method overwrites Iterator.next() with a one change: The resulting element is never null.
CSVRecord	peek()	This method returns the next element which will be returned by next(), without moving forward.

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.puresoltechnologies.streaming.iterators.StreamIterator

empty, filter, flatMap, map, of, spliterator, stream

Constructor Detail

CSVReader

public CSVReader(InputStream inputStream)

CSVReader

public CSVReader(InputStream inputStream,
                 Charset charset)

CSVReader

public CSVReader(InputStream inputStream,
                 boolean hasHeader)

CSVReader

public CSVReader(InputStream inputStream,
                 Charset charset,
                 boolean hasHeader)

Method Detail

getHeader

public CSVHeader getHeader()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<CSVRecord>

next

public CSVRecord next()
               throws NoSuchElementException

Description copied from interface: StreamIterator

This method overwrites Iterator.next() with a one change: The resulting element is never null.

Specified by:

next in interface Iterator<CSVRecord>

Specified by:

next in interface StreamIterator<CSVRecord>

Returns:

An object of generic type T is returned. If the stream has reached its end, a NoSuchElementException is thrown. Iterator.hasNext() will returned false in this case and should be asked for the presence of more elements in advance. The result is never null.

Throws:

NoSuchElementException - is thrown in case the stream has reached its end.

peek

public CSVRecord peek()
               throws NoSuchElementException

Description copied from interface: StreamIterator

This method returns the next element which will be returned by next(), without moving forward.

Specified by:

peek in interface StreamIterator<CSVRecord>

Returns:

An object of generic type T is returned. If the stream has reached its end, a NoSuchElementException is thrown. Iterator.hasNext() will returned false in this case and should be asked for the presence of more elements in advance. The result is never null.

Throws:

NoSuchElementException - is thrown in case the stream has reached its end.