Class CompoundDocument.SeekableLittleEndianDataInputStream

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private SeekableInputStream seekable  
      • Fields inherited from class java.io.FilterInputStream

        in
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void flush()
      Discards the initial position of the stream prior to the current stream position.
      void flushBefore​(long pPosition)
      Discards the initial portion of the stream prior to the indicated postion.
      long getFlushedPosition()
      Returns the earliest position in the stream to which seeking may be performed.
      long getStreamPosition()
      Returns the current byte position of the stream.
      boolean isCached()
      Returns true if this Seekable stream caches data itself in order to allow seeking backwards.
      boolean isCachedFile()
      Returns true if this Seekable stream caches data itself in order to allow seeking backwards, and the cache is kept in a temporary file.
      boolean isCachedMemory()
      Returns true if this Seekable stream caches data itself in order to allow seeking backwards, and the cache is kept in main memory.
      void mark()
      Marks a position in the stream to be returned to by a subsequent call to reset.
      void reset()
      Returns the file pointer to its previous position, at the time of the most recent unmatched call to mark.
      void seek​(long pPosition)
      Sets the current stream position to the desired location.
      • Methods inherited from class java.io.FilterInputStream

        available, close, mark, markSupported, read, read, read, skip
      • Methods inherited from class java.io.InputStream

        nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.twelvemonkeys.io.Seekable

        close
    • Constructor Detail

      • SeekableLittleEndianDataInputStream

        public SeekableLittleEndianDataInputStream​(SeekableInputStream pInput)
    • Method Detail

      • seek

        public void seek​(long pPosition)
                  throws java.io.IOException
        Description copied from interface: Seekable
        Sets the current stream position to the desired location. The next read will occur at this location.

        An IndexOutOfBoundsException will be thrown if pPosition is smaller than the flushed position (as returned by Seekable.getFlushedPosition()).

        It is legal to seek past the end of the file; an EOFException will be thrown only if a read is performed.

        Specified by:
        seek in interface Seekable
        Parameters:
        pPosition - a long containing the desired file pointer position.
        Throws:
        java.io.IOException - if any other I/O error occurs.
      • isCachedFile

        public boolean isCachedFile()
        Description copied from interface: Seekable
        Returns true if this Seekable stream caches data itself in order to allow seeking backwards, and the cache is kept in a temporary file. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.
        Specified by:
        isCachedFile in interface Seekable
        Returns:
        true if this Seekable caches data in a temporary file.
        See Also:
        Seekable.isCached(), Seekable.isCachedMemory()
      • isCachedMemory

        public boolean isCachedMemory()
        Description copied from interface: Seekable
        Returns true if this Seekable stream caches data itself in order to allow seeking backwards, and the cache is kept in main memory. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.
        Specified by:
        isCachedMemory in interface Seekable
        Returns:
        true if this Seekable caches data in main memory.
        See Also:
        Seekable.isCached(), Seekable.isCachedFile()
      • isCached

        public boolean isCached()
        Description copied from interface: Seekable
        Returns true if this Seekable stream caches data itself in order to allow seeking backwards. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.
        Specified by:
        isCached in interface Seekable
        Returns:
        true if this Seekable caches data.
        See Also:
        Seekable.isCachedMemory(), Seekable.isCachedFile()
      • getStreamPosition

        public long getStreamPosition()
                               throws java.io.IOException
        Description copied from interface: Seekable
        Returns the current byte position of the stream. The next read will take place starting at this offset.
        Specified by:
        getStreamPosition in interface Seekable
        Returns:
        a long containing the position of the stream.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • getFlushedPosition

        public long getFlushedPosition()
                                throws java.io.IOException
        Description copied from interface: Seekable
        Returns the earliest position in the stream to which seeking may be performed. The returned value will be the maximum of all values passed into previous calls to flushBefore.
        Specified by:
        getFlushedPosition in interface Seekable
        Returns:
        the earliest legal position for seeking, as a long.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • flushBefore

        public void flushBefore​(long pPosition)
                         throws java.io.IOException
        Description copied from interface: Seekable
        Discards the initial portion of the stream prior to the indicated postion. Attempting to seek to an offset within the flushed portion of the stream will result in an IndexOutOfBoundsException.

        Calling flushBefore may allow classes implementing this interface to free up resources such as memory or disk space that are being used to store data from the stream.

        Specified by:
        flushBefore in interface Seekable
        Parameters:
        pPosition - a long containing the length of the file prefix that may be flushed.
        Throws:
        java.io.IOException - if an I/O error occurs.
      • flush

        public void flush()
                   throws java.io.IOException
        Description copied from interface: Seekable
        Discards the initial position of the stream prior to the current stream position. Equivalent to flushBefore(getStreamPosition()).
        Specified by:
        flush in interface Seekable
        Throws:
        java.io.IOException - if an I/O error occurs.
      • reset

        public void reset()
                   throws java.io.IOException
        Description copied from interface: Seekable
        Returns the file pointer to its previous position, at the time of the most recent unmatched call to mark.

        Calls to reset without a corresponding call to mark will either:

        • throw an IOException
        • or, reset to the beginning of the stream.

        An IOException will be thrown if the previous marked position lies in the discarded portion of the stream.

        Specified by:
        reset in interface Seekable
        Overrides:
        reset in class java.io.FilterInputStream
        Throws:
        java.io.IOException - if an I/O error occurs.
        See Also:
        InputStream.reset()
      • mark

        public void mark()
        Description copied from interface: Seekable
        Marks a position in the stream to be returned to by a subsequent call to reset. Unlike a standard InputStream, all Seekable streams upport marking. Additionally, calls to mark and reset may be nested arbitrarily.

        Unlike the mark methods declared by the Reader or InputStream interfaces, no readLimit parameter is used. An arbitrary amount of data may be read following the call to mark.

        Specified by:
        mark in interface Seekable