Top Description Fields Constructors Methods

org.apache.poi.hssf.model

public final Class RecordStream

Class Inheritance

extends Object

java.lang.Object
org.apache.poi.hssf.model.RecordStream

Imports

java.util.List, .NoSuchElementException, org.apache.poi.hssf.record.Record

Simplifies iteration over a sequence of Record objects.

Field Summary

Modifier and Type	Field and Description
private int	_countRead
private final int	_endIx
private final List<Record>	_list
private int	_nextIndex

Constructor Summary

Access	Constructor and Description
public	RecordStream(List<Record> the list to iterate over inputList, int the start index within the list startIndex, int the end index within the list, which is the index of the end element + 1 endIx) Creates a RecordStream bounded by startIndex and endIndex
public	RecordStream(List<Record> records, int startIx)

Method Summary

Modifier and Type	Method and Description
public int	getCountRead()
public Record	getNext()
public boolean	hasNext()
public Class<? extends Record>	Returns: the `Class` of the next Record. `null` if this stream is exhausted. peekNextClass()
public Record	Returns: the next Record. `null` if this stream is exhausted. peekNextRecord()
public int	Returns: -1 if at end of records peekNextSid()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_countRead	back to summary
private int _countRead

_endIx	back to summary
private final int _endIx

_list	back to summary
private final List<Record> _list

_nextIndex	back to summary
private int _nextIndex

Constructor Detail

RecordStream

back to summary

public RecordStream(List<Record> inputList, int startIndex, int endIx)

Creates a RecordStream bounded by startIndex and endIndex

Parameters

inputList:List<Record>: the list to iterate over
startIndex:int: the start index within the list
endIx:int: the end index within the list, which is the index of the end element + 1

RecordStream	back to summary
public RecordStream(List<Record> records, int startIx)

Method Detail

getCountRead	back to summary
public int getCountRead()

getNext	back to summary
public Record getNext()

hasNext	back to summary
public boolean hasNext()

peekNextClass	back to summary
public Class<? extends Record> peekNextClass() Returns:Class<? extends Record> the `Class` of the next Record. `null` if this stream is exhausted.

peekNextRecord	back to summary
public Record peekNextRecord() Returns:Record the next Record. `null` if this stream is exhausted.

peekNextSid	back to summary
public int peekNextSid() Returns:int -1 if at end of records