Class RereadableInputStream

  • All Implemented Interfaces:
    Closeable, AutoCloseable

    public class RereadableInputStream
    extends InputStream
    Wraps an input stream, reading it only once, but making it available for rereading an arbitrary number of times. The stream's bytes are stored in memory up to a user specified maximum, and then stored in a temporary file which is deleted when this class' close() method is called.
    • Constructor Detail

      • RereadableInputStream

        public RereadableInputStream​(InputStream inputStream,
                                     int maxBytesInMemory,
                                     boolean readToEndOfStreamOnFirstRewind,
                                     boolean closeOriginalStreamOnClose)
        Creates a rereadable input stream.
        inputStream - stream containing the source of data
        maxBytesInMemory - maximum number of bytes to use to store the stream's contents in memory before switching to disk; note that the instance will preallocate a byte array whose size is maxBytesInMemory. This byte array will be made available for garbage collection (i.e. its reference set to null) when the content size exceeds the array's size, when close() is called, or when there are no more references to the instance.
        readToEndOfStreamOnFirstRewind - Specifies whether or not to read to the end of stream on first rewind. If this is set to false, then when rewind() is first called, only those bytes already read from the original stream will be available from then on.
    • Method Detail

      • read

        public int read()
                 throws IOException
        Reads a byte from the stream, saving it in the store if it is being read from the original stream. Implements the abstract
        Specified by:
        read in class InputStream
        the read byte, or -1 on end of stream.
      • rewind

        public void rewind()
                    throws IOException
        "Rewinds" the stream to the beginning for rereading.
      • getSize

        public int getSize()
        Returns the number of bytes read from the original stream.
        number of bytes read