net.sf.sevenzipjbinding.simple.ISimpleInArchiveItem 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 java.util.Date;

import net.sf.sevenzipjbinding.ExtractOperationResult;
import net.sf.sevenzipjbinding.ISequentialOutStream;
import net.sf.sevenzipjbinding.SevenZipException;

/**
 * This java interface represents a archive item. There are no corresponding interface in original SevenZip api.

 * 

 * 
 * This interface is a part of simplified 7-Zip-JBinding interface.
 * 
 * 
 * @see ISimpleInArchive
 * @author Boris Brodski
 * @version 4.65-1
 */
public interface ISimpleInArchiveItem {

	/**
	 * Full path, name and extension of the file inside the archive. Example. 'dir/file.ext'. Please note, that stream archive
	 * formats such as gzip does not support this property, since it is always a single file (or stream) being
	 * compressed.

	 * 
	 * @return full path, name and extension of the item in archive.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public String getPath() throws SevenZipException;

	/**
	 * Original size of the item. -1 is returned, if no size known for this item.
	 * 
	 * @return Original size of the item or -1 

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Long getSize() throws SevenZipException;

	/**
	 * Size of the packed item in archive. Sometimes 0 will be returned. It means either unknown or
	 * the item shares compressed data with other items and so take no additional space in archive.
	 * 
	 * @return packed size of item in archive

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Long getPackedSize() throws SevenZipException;

	/**
	 * Returns flag either a item represents a folder or not. Please note, that some archive formats doesn't define
	 * special items for folders. In this case you may get a item with a path 'dir/file' without having an item for 'dir'
	 * at all. 

	 * 

	 * 
	 * @return true if item is a folder, otherwise false. false is returned, if
	 *         archive format doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public boolean isFolder() throws SevenZipException;

	/**
	 * Return item attributes.

	 * 

	 * Supported by all methods
	 * 
	 *  Zip
	 * 
 7Z
	 * 
 Arj
	 * 
 Cab
	 * 
 Rar
	 * 
	 * 
	 * @return attributes of item

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Integer getAttributes() throws SevenZipException;

	/**
	 * Return creation date and time of the item.

	 * 

	 * Supported by all methods
	 * 
	 *  7Z
	 * 
 Rar
	 * 
	 * 
	 * @return creation date and time of the item

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Date getCreationTime() throws SevenZipException;

	/**
	 * Return last access date and time of the item.

	 * 

	 * Supported by all methods
	 * 
	 *  7Z
	 * 
 Rar
	 * 
	 * 
	 * @return last access date and time of the item.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Date getLastAccessTime() throws SevenZipException;

	/**
	 * Return last write date and time of the item.

	 * 

	 * Supported by all methods, but
	 * 
	 *  BZ2
	 * 
 Chm
	 * 
 RPM
	 * 
 Split
	 * 
 Z
	 * 
	 * 
	 * @return last write date and time of the item

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Date getLastWriteTime() throws SevenZipException;

	/**
	 * Flag either a item encrypted or not.
	 * 
	 * @return true if item is encrypted, otherwise false. false is returned, if
	 *         archive format doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public boolean isEncrypted() throws SevenZipException;

	/**
	 * Return true if item was commented, otherwise false.
	 * 
	 * @return true if item was commented, otherwise false.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Boolean isCommented() throws SevenZipException;

	/**
	 * Return CRC checksum of the item content.
	 * 
	 * @return CRC checksum of the item content

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Integer getCRC() throws SevenZipException;

	/**
	 * Return string title of item compress method.
	 * 
	 * @return string title of item compress method

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public String getMethod() throws SevenZipException;

	/**
	 * TODO: the purpose of position isn't clear
	 * 
	 * @return TODO
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public Integer getPosition() throws SevenZipException;

	/**
	 * Return host OS of item. TODO: The meaning of the hostOS property is unknown
	 * 
	 * @return host OS of item.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public String getHostOS() throws SevenZipException;

	/**
	 * Return parent user of the item.
	 * 
	 * @return parent user of the item.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public String getUser() throws SevenZipException;

	/**
	 * Return parent group of the item.
	 * 
	 * @return parent group of the item.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public String getGroup() throws SevenZipException;

	/**
	 * Return comments for the item.
	 * 
	 * @return comments for the item.

	 *         null will be returned, if current archive type doesn't support this property.
	 * 
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public String getComment() throws SevenZipException;

	/**
	 * Extract one archive item. Use sequentialOutStream to output data.

	 * 

	 * WARNING: this is very slow operation for multiple calls.
	 * 
	 * @param sequentialOutStream
	 *            output stream to use
	 * 
	 * @return result of operation
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public ExtractOperationResult extractSlow(ISequentialOutStream sequentialOutStream) throws SevenZipException;

	/**
	 * Extract one archive item. Use sequentialOutStream to output data.

	 * 

	 * WARNING: this is very slow operation for multiple calls.
	 * 
	 * @param sequentialOutStream
	 *            output stream to use
	 * @param password
	 *            password to use
	 * @return result of operation
	 * @throws SevenZipException
	 *             7-Zip or 7-Zip-JBinding intern error occur. Check exception message for more information.
	 */
	public ExtractOperationResult extractSlow(ISequentialOutStream sequentialOutStream, String password)
			throws SevenZipException;

	/**
	 * Returns the archive item index
	 * 
	 * @return the archive item index
	 */
	public int getItemIndex();
}