Package net.sf.sevenzipjbinding.impl

Class OutItem

java.lang.Object

net.sf.sevenzipjbinding.impl.OutItem

All Implemented Interfaces:

IOutItem7z, IOutItemAllFormats, IOutItemBase, IOutItemBZip2, IOutItemGZip, IOutItemTar, IOutItemXz, IOutItemZip

public final class OutItem
extends Object
implements IOutItemAllFormats

Implementation of the all IOutItemXxx interfaces. Contains information about a single archive item required for a create or update operation. Instances should be created by OutItemFactory. See IOutCreateCallback.getItemInformation(int, OutItemFactory) for details.

The purpose of the archive format specific interfaces IOutItemXxx is to hide methods unrelated to the corresponding archive format. For example, GZip format doesn't support the attributes property and so the IOutItemGZip interface doesn't contain corresponding getters and setter. The Zip archive format on the other hand does support the attributes property defining the methods:

• IOutItemZip.getPropertyAttributes()
• IOutItemZip.setPropertyAttributes(Integer)

Since:

9.20-2.00

Author:

Boris Brodski

See Also:

• IOutCreateCallback.getItemInformation(int, OutItemFactory)
• OutItemFactory
• IOutItemBase

Method Summary

Modifier and Type	Method	Description
ArchiveFormat	getArchiveFormat()	Return current archive format
Long	getDataSize()	Get property PropID.SIZE.
int	getIndex()	Return the index of the item being described in the new archive.
IOutArchive<?>	getOutArchive()	Return corresponding IOutArchive object.
Integer	getPropertyAttributes()	Get property PropID.ATTRIBUTES.
String	getPropertyComment()	Get property PropID.COMMENT.
Integer	getPropertyCRC()	Get property PropID.CRC.
Date	getPropertyCreationTime()	Get property PropID.CREATION_TIME.
Boolean	getPropertyEncrypted()	Get property PropID.ENCRYPTED.
String	getPropertyGroup()	Get property PropID.GROUP.
String	getPropertyHardLink()	Get property PropID.HARD_LINK.
Boolean	getPropertyIsAnti()	Get property PropID.IS_ANTI.
Boolean	getPropertyIsDir()	Get property PropID.IS_FOLDER.
Date	getPropertyLastAccessTime()	Get property PropID.LAST_ACCESS_TIME.
Date	getPropertyLastModificationTime()	Get property PropID.LAST_MODIFICATION_TIME.
String	getPropertyPath()	Get property PropID.PATH.
Integer	getPropertyPosixAttributes()	Get property PropID.POSIX_ATTRIB.
String	getPropertySymLink()	Get property PropID.SYM_LINK.
String	getPropertyUser()	Get property PropID.USER.
Boolean	getUpdateIsNewData()	Get whether the archive item data (content) has changed.
Boolean	getUpdateIsNewProperties()	Get whether the archive item properties have changed.
Integer	getUpdateOldArchiveItemIndex()	Get the index of the archive item in the archive being updated (old archive).
void	setDataSize(Long size)	Set property PropID.SIZE.
void	setPropertyAttributes(Integer attributes)	Set property PropID.ATTRIBUTES.
void	setPropertyComment(String comment)	Set property PropID.COMMENT.
void	setPropertyCRC(Integer crc)	Set property PropID.CRC.
void	setPropertyCreationTime(Date creationTime)	Set property PropID.CREATION_TIME.
void	setPropertyEncrypted(Boolean encrypted)	Set property PropID.ENCRYPTED.
void	setPropertyGroup(String group)	Set property PropID.GROUP.
void	setPropertyHardLink(String propertyHardLink)	Set property PropID.HARD_LINK.
void	setPropertyIsAnti(Boolean isAnti)	Set property PropID.IS_ANTI.
void	setPropertyIsDir(Boolean dir)	Set property PropID.IS_FOLDER.
void	setPropertyLastAccessTime(Date lastAccessTime)	Set property PropID.LAST_ACCESS_TIME.
void	setPropertyLastModificationTime(Date modificationTime)	Set property PropID.LAST_MODIFICATION_TIME.
void	setPropertyPath(String path)	Set property PropID.PATH.
void	setPropertyPosixAttributes(Integer posixAttributes)	Set property PropID.POSIX_ATTRIB.
void	setPropertySymLink(String propertySymLink)	Set property PropID.SYM_LINK.
void	setPropertyUser(String user)	Set property PropID.USER.
void	setUpdateIsNewData(Boolean updateIsNewData)	Set whether the archive item data (content) has changed.
void	setUpdateIsNewProperties(Boolean updateIsNewProperties)	Set whether the archive item properties have changed.
void	setUpdateOldArchiveItemIndex(Integer updateOldArchiveItemIndex)	Set the index of the archive item in the archive being updated (old archive).

Methods inherited from class java.lang.Object

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

Method Details

getIndex

public int getIndex()

Return the index of the item being described in the new archive.

Specified by:

getIndex in interface IOutItemBase

Returns:

the index of the item in the archive (0-based)

getOutArchive

public IOutArchive<?> getOutArchive()

Description copied from interface: IOutItemBase

Return corresponding IOutArchive object.

Specified by:

getOutArchive in interface IOutItemBase

Returns:

IOutArchive

getArchiveFormat

public ArchiveFormat getArchiveFormat()

Return current archive format

Specified by:

getArchiveFormat in interface IOutItemBase

Returns:

archive format

getDataSize

public Long getDataSize()

Get property PropID.SIZE.

Specified by:

getDataSize in interface IOutItemBase

Returns:

size.

See Also:

• PropID.SIZE

setDataSize

public void setDataSize(Long size)

Set property PropID.SIZE.

Specified by:

setDataSize in interface IOutItemBase

Parameters:

size - see PropID.SIZE

See Also:

• PropID.SIZE

getPropertyAttributes

public Integer getPropertyAttributes()

Get property PropID.ATTRIBUTES.

Specified by:

getPropertyAttributes in interface IOutItem7z

Specified by:

getPropertyAttributes in interface IOutItemZip

Returns:

attributes

See Also:

• PropID.ATTRIBUTES

setPropertyAttributes

public void setPropertyAttributes(Integer attributes)

Set property PropID.ATTRIBUTES.

Specified by:

setPropertyAttributes in interface IOutItem7z

Specified by:

setPropertyAttributes in interface IOutItemZip

Parameters:

attributes - see PropID.ATTRIBUTES

See Also:

• PropID.ATTRIBUTES

getPropertyPosixAttributes

public Integer getPropertyPosixAttributes()

Get property PropID.POSIX_ATTRIB.

Specified by:

getPropertyPosixAttributes in interface IOutItemTar

Returns:

posix attributes

See Also:

• PropID.POSIX_ATTRIB

setPropertyPosixAttributes

public void setPropertyPosixAttributes(Integer posixAttributes)

Set property PropID.POSIX_ATTRIB.

Specified by:

setPropertyPosixAttributes in interface IOutItemTar

Parameters:

posixAttributes - see PropID.POSIX_ATTRIB

See Also:

• PropID.POSIX_ATTRIB

getPropertyPath

public String getPropertyPath()

Get property PropID.PATH.

Specified by:

getPropertyPath in interface IOutItem7z

Specified by:

getPropertyPath in interface IOutItemGZip

Specified by:

getPropertyPath in interface IOutItemTar

Specified by:

getPropertyPath in interface IOutItemZip

Returns:

path

See Also:

• PropID.PATH

setPropertyPath

public void setPropertyPath(String path)

Set property PropID.PATH.

Specified by:

setPropertyPath in interface IOutItem7z

Specified by:

setPropertyPath in interface IOutItemGZip

Specified by:

setPropertyPath in interface IOutItemTar

Specified by:

setPropertyPath in interface IOutItemZip

Parameters:

path - see PropID.PATH

See Also:

• PropID.PATH

getPropertyIsDir

public Boolean getPropertyIsDir()

Get property PropID.IS_FOLDER.

Specified by:

getPropertyIsDir in interface IOutItem7z

Specified by:

getPropertyIsDir in interface IOutItemTar

Specified by:

getPropertyIsDir in interface IOutItemZip

Returns:

dir

See Also:

• PropID.IS_FOLDER

setPropertyIsDir

public void setPropertyIsDir(Boolean dir)

Set property PropID.IS_FOLDER.

Specified by:

setPropertyIsDir in interface IOutItem7z

Specified by:

setPropertyIsDir in interface IOutItemTar

Specified by:

setPropertyIsDir in interface IOutItemZip

Parameters:

dir - see PropID.IS_FOLDER

See Also:

• PropID.IS_FOLDER

getPropertyLastModificationTime

public Date getPropertyLastModificationTime()

Get property PropID.LAST_MODIFICATION_TIME.

Specified by:

getPropertyLastModificationTime in interface IOutItem7z

Specified by:

getPropertyLastModificationTime in interface IOutItemGZip

Specified by:

getPropertyLastModificationTime in interface IOutItemTar

Specified by:

getPropertyLastModificationTime in interface IOutItemZip

Returns:

last modification time

See Also:

• PropID.LAST_MODIFICATION_TIME

setPropertyLastModificationTime

public void setPropertyLastModificationTime(Date modificationTime)

Set property PropID.LAST_MODIFICATION_TIME.

Specified by:

setPropertyLastModificationTime in interface IOutItem7z

Specified by:

setPropertyLastModificationTime in interface IOutItemGZip

Specified by:

setPropertyLastModificationTime in interface IOutItemTar

Specified by:

setPropertyLastModificationTime in interface IOutItemZip

Parameters:

modificationTime - see PropID.LAST_MODIFICATION_TIME

See Also:

• PropID.LAST_MODIFICATION_TIME

getPropertyLastAccessTime

public Date getPropertyLastAccessTime()

Get property PropID.LAST_ACCESS_TIME.

Specified by:

getPropertyLastAccessTime in interface IOutItemZip

Returns:

last access time

See Also:

• PropID.LAST_ACCESS_TIME

setPropertyLastAccessTime

public void setPropertyLastAccessTime(Date lastAccessTime)

Set property PropID.LAST_ACCESS_TIME.

Specified by:

setPropertyLastAccessTime in interface IOutItemZip

Parameters:

lastAccessTime - see PropID.LAST_ACCESS_TIME

See Also:

• PropID.LAST_ACCESS_TIME

getPropertyCreationTime

public Date getPropertyCreationTime()

Get property PropID.CREATION_TIME.

Specified by:

getPropertyCreationTime in interface IOutItemZip

Returns:

creation time

See Also:

• PropID.CREATION_TIME

setPropertyCreationTime

public void setPropertyCreationTime(Date creationTime)

Set property PropID.CREATION_TIME.

Specified by:

setPropertyCreationTime in interface IOutItemZip

Parameters:

creationTime - see PropID.CREATION_TIME

See Also:

• PropID.CREATION_TIME

getPropertyUser

public String getPropertyUser()

Get property PropID.USER.

Specified by:

getPropertyUser in interface IOutItemTar

Returns:

user

See Also:

• PropID.USER

setPropertyUser

public void setPropertyUser(String user)

Set property PropID.USER.

Specified by:

setPropertyUser in interface IOutItemTar

Parameters:

user - see PropID.USER

See Also:

• PropID.USER

getPropertyGroup

public String getPropertyGroup()

Get property PropID.GROUP.

Specified by:

getPropertyGroup in interface IOutItemTar

Returns:

group

See Also:

• PropID.GROUP

setPropertyGroup

public void setPropertyGroup(String group)

Set property PropID.GROUP.

Specified by:

setPropertyGroup in interface IOutItemTar

Parameters:

group - see PropID.GROUP

See Also:

• PropID.GROUP

getPropertySymLink

public String getPropertySymLink()

Get property PropID.SYM_LINK.

Specified by:

getPropertySymLink in interface IOutItemTar

Returns:

symLink

See Also:

• PropID.SYM_LINK

setPropertySymLink

public void setPropertySymLink(String propertySymLink)

Set property PropID.SYM_LINK.

Specified by:

setPropertySymLink in interface IOutItemTar

Parameters:

propertySymLink - see PropID.SYM_LINK

See Also:

• PropID.SYM_LINK

getPropertyHardLink

public String getPropertyHardLink()

Get property PropID.HARD_LINK.

Specified by:

getPropertyHardLink in interface IOutItemTar

Returns:

hardLink

See Also:

• PropID.HARD_LINK

setPropertyHardLink

public void setPropertyHardLink(String propertyHardLink)

Set property PropID.HARD_LINK.

Specified by:

setPropertyHardLink in interface IOutItemTar

Parameters:

propertyHardLink - see PropID.HARD_LINK

See Also:

• PropID.HARD_LINK

getPropertyIsAnti

public Boolean getPropertyIsAnti()

Get property PropID.IS_ANTI.

Specified by:

getPropertyIsAnti in interface IOutItem7z

Returns:

isAnti flag

See Also:

• PropID.IS_ANTI

setPropertyIsAnti

public void setPropertyIsAnti(Boolean isAnti)

Set property PropID.IS_ANTI.

Specified by:

setPropertyIsAnti in interface IOutItem7z

Parameters:

isAnti - see PropID.IS_ANTI.

See Also:

• PropID.IS_ANTI

getPropertyComment

public String getPropertyComment()

Get property PropID.COMMENT.

Specified by:

getPropertyComment in interface IOutItem7z

Returns:

comment

See Also:

• PropID.COMMENT

setPropertyComment

public void setPropertyComment(String comment)

Set property PropID.COMMENT.

Specified by:

setPropertyComment in interface IOutItem7z

Parameters:

comment - see PropID.COMMENT

See Also:

• PropID.COMMENT

getPropertyEncrypted

public Boolean getPropertyEncrypted()

Get property PropID.ENCRYPTED.

Specified by:

getPropertyEncrypted in interface IOutItem7z

Returns:

encrypted flag

See Also:

• PropID.ENCRYPTED

setPropertyEncrypted

public void setPropertyEncrypted(Boolean encrypted)

Set property PropID.ENCRYPTED.

Specified by:

setPropertyEncrypted in interface IOutItem7z

Parameters:

encrypted - see PropID.ENCRYPTED

See Also:

• PropID.ENCRYPTED

getPropertyCRC

public Integer getPropertyCRC()

Get property PropID.CRC.

Specified by:

getPropertyCRC in interface IOutItem7z

Returns:

CRC checksum

See Also:

• PropID.CRC

setPropertyCRC

public void setPropertyCRC(Integer crc)

Set property PropID.CRC.

Specified by:

setPropertyCRC in interface IOutItem7z

Parameters:

crc - see PropID.CRC

See Also:

• PropID.CRC

getUpdateIsNewData

public Boolean getUpdateIsNewData()

Get whether the archive item data (content) has changed. If isNewData is true, isNewProperties must also be true

Note: only relevant for archive update operations!

Specified by:

getUpdateIsNewData in interface IOutItemBase

Returns:

true - the archive item has new data (always true for new archives),
false - the archive item data from the old archive can be reused.

setUpdateIsNewData

public void setUpdateIsNewData(Boolean updateIsNewData)

Set whether the archive item data (content) has changed. If isNewData is true, isNewProperties must also be true.

Note: only relevant for archive update operations!

Specified by:

setUpdateIsNewData in interface IOutItemBase

Parameters:

updateIsNewData - true - the archive item has new data (always true for new archives),
false - the archive item data from the old archive can be reused.

getUpdateIsNewProperties

public Boolean getUpdateIsNewProperties()

Get whether the archive item properties have changed. If isNewData is true, isNewProperties must also be true

Note: only relevant for archive update operations!

Specified by:

getUpdateIsNewProperties in interface IOutItemBase

Returns:

true - the archive item has new properties (always true for new archives).
false - the archive item properties from the old archive should be reused.

setUpdateIsNewProperties

public void setUpdateIsNewProperties(Boolean updateIsNewProperties)

Set whether the archive item properties have changed. If isNewData is true, isNewProperties must also be true

Note: only relevant for archive update operations!

Specified by:

setUpdateIsNewProperties in interface IOutItemBase

Parameters:

updateIsNewProperties - true - the archive item has new properties (always true for new archives).
false - the archive item properties from the old archive should be reused.

getUpdateOldArchiveItemIndex

public Integer getUpdateOldArchiveItemIndex()

Get the index of the archive item in the archive being updated (old archive). Mandatory, if isNewData or isNewProperties set.

Note: only relevant for archive update operations!

Specified by:

getUpdateOldArchiveItemIndex in interface IOutItemBase

Returns:

corresponding index of the archive item in the old archive (starting from 0).
-1 if both isNewData and isNewProperties are true.

setUpdateOldArchiveItemIndex

public void setUpdateOldArchiveItemIndex(Integer updateOldArchiveItemIndex)

Set the index of the archive item in the archive being updated (old archive).

Note: only relevant for archive update operations!

Specified by:

setUpdateOldArchiveItemIndex in interface IOutItemBase

Parameters:

updateOldArchiveItemIndex - corresponding index of the archive item in the old archive (starting from 0).
-1 if there is no corresponding archive item in the old archive or if doesn't matter (for new archives).