net.sf.sevenzipjbinding.simple.ISimpleInArchive Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jwrapper-7zip-jbinding Show documentation

${project.organization.name} JWrapper 7zip Jbinding

The newest version!

package net.sf.sevenzipjbinding.simple;

import net.sf.sevenzipjbinding.ISevenZipInArchive;
import net.sf.sevenzipjbinding.SevenZipException;

/**
 * Simplified interface for C++ IInArchive. For binding of original 7-Zip C++ interface see
 * {@link ISevenZipInArchive}.
 * 
 * 
 * @author Boris Brodski
 * @version 4.65-1
 */
public interface ISimpleInArchive {
	/**
	 * Close archive. No more archive operations are possible.

	 * Note: This method should be always called to free system resources.
	 * 
	 * @throws SevenZipException
	 *             intern error occurs. See {@link SevenZipException#getMessage()} for details.
	 */
	public void close() throws SevenZipException;

	/**
	 * Return count of items in archive.
	 * 
	 * @return count of item in archive.
	 * 
	 * @throws SevenZipException
	 *             error occurs. See {@link SevenZipException#getMessage()} for details.
	 */
	public int getNumberOfItems() throws SevenZipException;

	/**
	 * Return array of archive items with {@link #getNumberOfItems()} elements.
	 * 
	 * @return array of archive items
	 * @throws SevenZipException
	 *             error occurs. See {@link SevenZipException#getMessage()} for details.
	 */
	public ISimpleInArchiveItem[] getArchiveItems() throws SevenZipException;

	/**
	 * Return a simple representation of the archive item with index index.
	 * 
	 * @param index
	 *            index of the archive item to return
	 * @return corresponding instance of {@link ISimpleInArchiveItem}
	 * @throws SevenZipException
	 *             error occurs. See {@link SevenZipException#getMessage()} for details.
	 */
	public ISimpleInArchiveItem getArchiveItem(int index) throws SevenZipException;
}