Package org.apache.poi.hssf.record

Class RecordFactoryInputStream

  • public final class RecordFactoryInputStream
extends java.lang.Object
    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 Summary

      Constructors 
      Constructor Description
      RecordFactoryInputStream​(java.io.InputStream in, boolean shouldIncludeContinueRecords)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Record nextRecord()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RecordFactoryInputStream

        public RecordFactoryInputStream​(java.io.InputStream in,
                                boolean shouldIncludeContinueRecords)
        Parameters:
        in - the InputStream to read from
        shouldIncludeContinueRecords - caller can pass false if loose ContinueRecords should be skipped (this is sometimes useful in event based processing).

    • Method Detail

      • nextRecord

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