com.github.pjfanning.xlsx.impl

Class StreamingSheetReader

java.lang.Object

com.github.pjfanning.xlsx.impl.StreamingSheetReader

All Implemented Interfaces:

Iterable<Row>

public class StreamingSheetReader
extends Object
implements Iterable<Row>

Method Summary

Modifier and Type	Method and Description
void	close()
CloseableIterator<Row>	iterator() Returns a new streaming iterator to loop through rows.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

public CloseableIterator<Row> iterator()
                                throws OpenException,
                                       ReadException

Returns a new streaming iterator to loop through rows. This iterator is not guaranteed to have all rows in memory, and any particular iteration may trigger a load from disk to read in new data. This is an iterator of the PHYSICAL rows. Meaning the 3rd element may not be the third row if say for instance the second row is undefined. This behaviour changed in v4.0.0. Earlier versions only created one iterator and repeated calls to this method just returned the same iterator. Creating multiple iterators will slow down your application and should be avoided unless necessary.

Specified by:

iterator in interface Iterable<Row>

Returns:

the streaming iterator, an instance of CloseableIterator - it is recommended that you close the iterator when finished with it if you intend to keep the sheet open.

Throws:

OpenException - if there is an IO issue

ReadException - if there is a parse issue

close

public void close()
           throws CloseException

Throws:

CloseException