org.apache.poi.hssf.eventusermodel: public class: HSSFRecordStream

org.apache.poi.hssf.eventusermodel
public class: HSSFRecordStream [javadoc | source]

java.lang.Object
   org.apache.poi.hssf.eventusermodel.HSSFRecordStream

A stream based way to get at complete records, with as low a memory footprint as possible. This handles reading from a RecordInputStream, turning the data into full records, processing continue records etc. Most users should use HSSFEventFactory / HSSFListener and have new records pushed to them, but this does allow for a "pull" style of coding.

Constructor:
public HSSFRecordStream(RecordInputStream inp) { this.in = inp; }

Method from org.apache.poi.hssf.eventusermodel.HSSFRecordStream Summary:
nextRecord

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.poi.hssf.eventusermodel.HSSFRecordStream Detail:
public Record nextRecord() { Record r = null; // Loop until we get something while(r == null && !complete) { // Are there any bonus records that we need to // return? r = getBonusRecord(); // If not, ask for the next real record if(r == null) { r = getNextRecord(); } } // All done return r; } Returns the next (complete) record from the stream, or null if there are no more.

Method from org.apache.poi.hssf.eventusermodel.HSSFRecordStream Detail:

 public Record nextRecord() {
		Record r = null;
		// Loop until we get something
		while(r == null && !complete) {
			// Are there any bonus records that we need to
			//  return?
			r = getBonusRecord();
			// If not, ask for the next real record
			if(r == null) {
				r = getNextRecord();
			}
		}
		// All done
		return r;
}

Returns the next (complete) record from the stream, or null if there are no more.