net.sf.sevenzipjbinding.ISeekableStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sevenzipjbinding Show documentation

7-Zip-JBinding is a free cross-platform java binding of 7-Zip free compress/decompress library (http://www.7-zip.org/, http://p7zip.sourceforge.net/)

The newest version!

package net.sf.sevenzipjbinding;

/**
 * Interface for seekable streams (random access streams).
 *
 * @author Boris Brodski
 * @since 9.20-2.00
 */
public interface ISeekableStream {
    /**
     * Indicates, that the seek operation should be done from the beginning of the stream
     */
    public static final int SEEK_SET = 0;

    /**
     * Indicates, that the seek operation should be done from the current position (file pointer) of the stream.
     * Positive values move file pointer forward.
     */
    public static final int SEEK_CUR = 1;

    /**
     * Indicates, that the seek operation should be done from the end of the stream. Positive offset values move file
     * pointer over the end of the stream. For the read only streams it's equivalent reaching end of the stream while
     * reading.
     */
    public static final int SEEK_END = 2;

    /**
     * Move current location pointer to the new offset depending on seekOrigin.

     * 

     * Note: depending on the archive format and the data size this method may be called from different threads.
     * Synchronized implementation may be required.
     *
     *
     * @param offset
     *            absolute or relative offset in the stream to move to
     * @param seekOrigin
     *            on of three possible seek origins:

     *            
     *            {@link #SEEK_SET} - offset is an absolute offset to move to,
     *            
{@link #SEEK_CUR} - offset is a relative offset to the current position in stream,
     *            
{@link #SEEK_END} - offset is an offset from the end of the stream
     *            
     *            {@code (offset <= 0)}.
     *
     * @return new absolute position in the stream.
     *
     * @throws SevenZipException
     *             in error case. If this method ends with an exception, the current operation will be reported to 7-Zip
     *             as failed. There are no guarantee, that there are no further call back methods will get called. The
     *             first and last thrown exceptions will be saved and thrown later on from the originally called method
     *             such as ISevenZipInArchive.extract() or SevenZip.openInArchive(). Up to
     *             four exceptions depending on the situation can be saved for further analysis. See
     *             {@link SevenZipException} and {@link SevenZipException#printStackTraceExtended()} for details.
     */
    public long seek(long offset, int seekOrigin) throws SevenZipException;
}