Package net.sf.sevenzipjbinding.simple.impl

Class SimpleInArchiveItemImpl

java.lang.Object

net.sf.sevenzipjbinding.simple.impl.SimpleInArchiveItemImpl

All Implemented Interfaces:

ISimpleInArchiveItem

public class SimpleInArchiveItemImpl
extends Object
implements ISimpleInArchiveItem

Standard implementation of ISimpleInArchiveItem, simplified 7-Zip-JBinding interface.

Since:

4.65-1

Author:

Boris Brodski

Constructor Summary

Constructors

Constructor	Description
SimpleInArchiveItemImpl(IInArchive sevenZipInArchive, int index)	Create instance of SimpleInArchiveItemImpl representing archive item with index indexindex of archive sevenZipInArchive.
SimpleInArchiveItemImpl(SimpleInArchiveImpl simpleInArchiveImpl, int index)	Create instance of SimpleInArchiveItemImpl representing archive item with index indexindex of archive simpleInArchiveImpl.

Method Summary

Modifier and Type	Method	Description
ExtractOperationResult	extractSlow(ISequentialOutStream outStream)	Extract one archive item.
ExtractOperationResult	extractSlow(ISequentialOutStream outStream, String password)	Extract one archive item.
Integer	getAttributes()	Return item attributes. Supported by the following formats: Zip 7Z Arj Cab Rar
String	getComment()	Return comments for the item.
Integer	getCRC()	Return CRC checksum of the item content.
Date	getCreationTime()	Return creation date and time of the item. Supported by the following formats: 7Z Rar
String	getGroup()	Return parent group of the item.
String	getHostOS()	Return the host operating system recorded for the item, i.e.
int	getItemIndex()	Returns the archive item index
Date	getLastAccessTime()	Return last access date and time of the item. Supported by the following formats: 7Z Rar
Date	getLastWriteTime()	Return last write date and time of the item. Supported by all formats except the following: BZ2 Chm RPM Split Z
String	getMethod()	Return string title of item compress method.
Long	getPackedSize()	Size of the packed item in archive.
String	getPath()	Full path, name and extension of the file inside the archive.
Integer	getPosition()	Return the value of the item's POSITION property.
Long	getSize()	Original (uncompressed) size of the item in bytes.
String	getUser()	Return parent user of the item.
Boolean	isCommented()	Return true if item was commented, otherwise false.
boolean	isEncrypted()	Flag indicating whether the item is encrypted or not.
boolean	isFolder()	Returns a flag indicating whether the item represents a folder or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimpleInArchiveItemImpl

public SimpleInArchiveItemImpl(SimpleInArchiveImpl simpleInArchiveImpl,
 int index)

Create instance of SimpleInArchiveItemImpl representing archive item with index indexindex of archive simpleInArchiveImpl.

Parameters:

simpleInArchiveImpl - opened archive

index - index of the item in archive

SimpleInArchiveItemImpl

public SimpleInArchiveItemImpl(IInArchive sevenZipInArchive,
 int index)

Create instance of SimpleInArchiveItemImpl representing archive item with index indexindex of archive sevenZipInArchive.

Parameters:

sevenZipInArchive - opened archive

index - index of the item in archive

Method Details

getPath

public String getPath()
               throws SevenZipException

Full path, name and extension of the file inside the archive. Example: 'dir/file.ext'. Please note that stream archive formats such as gzip do not support this property, since they always compress a single file (or stream).

Specified by:

getPath in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getAttributes

public Integer getAttributes()
                      throws SevenZipException

Return item attributes.

Supported by the following formats:

• Zip
• 7Z
• Arj
• Cab
• Rar

Specified by:

getAttributes in interface ISimpleInArchiveItem

Returns:

attributes of item
null will be returned, if current archive type doesn't support this property.

Throws:

SevenZipException - 7-Zip or 7-Zip-JBinding error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getCRC

public Integer getCRC()
               throws SevenZipException

Return CRC checksum of the item content.

Specified by:

getCRC in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getComment

public String getComment()
                  throws SevenZipException

Return comments for the item.

Specified by:

getComment in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getCreationTime

public Date getCreationTime()
                     throws SevenZipException

Return creation date and time of the item.

Supported by the following formats:

• 7Z
• Rar

Specified by:

getCreationTime in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getGroup

public String getGroup()
                throws SevenZipException

Return parent group of the item.

Specified by:

getGroup in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getHostOS

public String getHostOS()
                 throws SevenZipException

Return the host operating system recorded for the item, i.e. the operating system on which the item was added to the archive. This is mainly relevant for formats such as Zip and RAR.

Specified by:

getHostOS in interface ISimpleInArchiveItem

Returns:

host OS of the item.
null will be returned, if current archive type doesn't support this property.

Throws:

SevenZipException - 7-Zip or 7-Zip-JBinding error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getLastAccessTime

public Date getLastAccessTime()
                       throws SevenZipException

Return last access date and time of the item.

Supported by the following formats:

• 7Z
• Rar

Specified by:

getLastAccessTime in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getLastWriteTime

public Date getLastWriteTime()
                      throws SevenZipException

Return last write date and time of the item.

Supported by all formats except the following:

• BZ2
• Chm
• RPM
• Split
• Z

Specified by:

getLastWriteTime in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getMethod

public String getMethod()
                 throws SevenZipException

Return string title of item compress method.

Specified by:

getMethod in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getPackedSize

public Long getPackedSize()
                   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.

Specified by:

getPackedSize in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getPosition

public Integer getPosition()
                    throws SevenZipException

Return the value of the item's POSITION property. This is a rarely used, format-specific property; for most archive formats it is not defined.

Specified by:

getPosition in interface ISimpleInArchiveItem

Returns:

value of the POSITION property
null will be returned, if the current archive type doesn't support this property.

Throws:

SevenZipException - 7-Zip or 7-Zip-JBinding error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getSize

public Long getSize()
             throws SevenZipException

Original (uncompressed) size of the item in bytes.

Specified by:

getSize in interface ISimpleInArchiveItem

Returns:

original size of the item in bytes
null will be returned, if the current archive type doesn't support this property.

Throws:

SevenZipException - 7-Zip or 7-Zip-JBinding error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getUser

public String getUser()
               throws SevenZipException

Return parent user of the item.

Specified by:

getUser in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

isCommented

public Boolean isCommented()
                    throws SevenZipException

Return true if item was commented, otherwise false.

Specified by:

isCommented in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

isEncrypted

public boolean isEncrypted()
                    throws SevenZipException

Flag indicating whether the item is encrypted or not.

Specified by:

isEncrypted in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

isFolder

public boolean isFolder()
                 throws SevenZipException

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

Specified by:

isFolder in interface ISimpleInArchiveItem

Returns:

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 error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

extractSlow

public ExtractOperationResult extractSlow(ISequentialOutStream outStream)
                                   throws SevenZipException

Description copied from interface: ISimpleInArchiveItem

Extract one archive item. Use sequentialOutStream to output data.

WARNING: this is a very slow operation when called repeatedly.

Specified by:

extractSlow in interface ISimpleInArchiveItem

Parameters:

outStream - output stream to use

Returns:

result of operation

Throws:

SevenZipException - 7-Zip or 7-Zip-JBinding error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

extractSlow

public ExtractOperationResult extractSlow(ISequentialOutStream outStream,
 String password)
                                   throws SevenZipException

Description copied from interface: ISimpleInArchiveItem

Extract one archive item. Use sequentialOutStream to output data.

WARNING: this is a very slow operation when called repeatedly.

Specified by:

extractSlow in interface ISimpleInArchiveItem

Parameters:

outStream - output stream to use

password - password to use

Returns:

result of operation

Throws:

SevenZipException - 7-Zip or 7-Zip-JBinding error occurs. Use SevenZipException.printStackTraceExtended() to get stack traces of this SevenZipException and of all thrown 'caused by' exceptions.

getItemIndex

public int getItemIndex()

Returns the archive item index

Specified by:

getItemIndex in interface ISimpleInArchiveItem

Returns:

the archive item index