net.sf.sevenzipjbinding.IProgress 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;

/**
 * This interface provides progress information of a process.
 * 
 * @author Boris Brodski
 * @since 4.65-1
 */
public interface IProgress {
    /**
     * Set total amount of work
     * 
     * @param total
     *            amount of work
     * 
     * @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 void setTotal(long total) throws SevenZipException;

    /**
     * Set current amount of completed work
     * 
     * @param complete
     *            amount of completed work
     * 
     * @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 void setCompleted(long complete) throws SevenZipException;
}