net.sf.sevenzipjbinding
Enum PropID

java.lang.Object
  extended by java.lang.Enum<PropID>
      extended by net.sf.sevenzipjbinding.PropID
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PropID>

public enum PropID
extends java.lang.Enum<PropID>

Enumeration for possible archive and archive item properties

Since:
4.65-1
Author:
Boris Brodski

Nested Class Summary
static class PropID.AttributesBitMask
          Windows file attribute bit mask.
 
Enum Constant Summary
ATTRIBUTES
          Archive item or file attributes.
BIG_ENDIAN
           
BIT64
           
BLOCK
           
CHARACTS
           
CHECKSUM
           
CLUSTER_SIZE
           
COMMENT
           
COMMENTED
           
CPU
           
CRC
           
CREATION_TIME
          Date and time of the file creation.
CREATOR_APP
           
DICTIONARY_SIZE
           
ENCRYPTED
          Flag either a item encrypted or not.
EXTENSION
           
FILE_SYSTEM
           
FREE_SPACE
           
GROUP
          Group (owner) of the file.

Type: String null will be returned, if current archive type doesn't support this property.
HANDLER_ITEM_INDEX
          Unknown purpose
HEADERS_SIZE
           
HOST_OS
           
ID
           
IS_ANTI
          If true delete corresponding file or directory during extraction.
IS_FOLDER
          Flag either a item represents a folder or not.
IS_VOLUME
           
LAST_ACCESS_TIME
          Date and time of last access of the file.
LAST_MODIFICATION_TIME
          Date and time the file was last time modified.

Type: Date null will be returned, if current archive type doesn't support this property.
LINK
           
LINKS
           
LOCAL_NAME
           
METHOD
           
NAME
          In IArchiveOpenCallback: Name of the volume to get
NO_PROPERTY1
          Dummy property1.
NO_PROPERTY2
          Dummy property2.
NUM_BLOCKS
           
NUM_SUB_DIRS
           
NUM_SUB_FILES
           
NUM_VOLUMES
           
OFFSET
           
PACKED_SIZE
          Size of the packed item in archive.
PATH
          Full path, name and extension of the file inside the archive.
PHY_SIZE
           
POSITION
           
POSIX_ATTRIB
          Posix attributes.

Type: Integer null will be returned, if current archive type doesn't support this property.
PREFIX
           
PROVIDER
           
SECTOR_SIZE
           
SHORT_NAME
           
SIZE
          Size of the original file.
SOLID
           
SPLIT_AFTER
           
SPLIT_BEFORE
           
TIME_TYPE
           
TOTAL_SIZE
           
TYPE
           
UNKNOWN
          Unknown PropID.
UNPACK_VER
           
USER
          User (owner) of the file.

Type: String null will be returned, if current archive type doesn't support this property.
USER_DEFINED
           
VA
           
VOLUME
           
VOLUME_NAME
           
 
Method Summary
static PropID getPropIDByIndex(int propIDIndex)
          Get enumeration element by native property index
 int getPropIDIndex()
          Native index of the property
static PropID valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PropID[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NO_PROPERTY1

public static final PropID NO_PROPERTY1
Dummy property1. First real property should have an item 2. So skip the position 2.


NO_PROPERTY2

public static final PropID NO_PROPERTY2
Dummy property2. First real property should have an item 2. So skip the position 1.


HANDLER_ITEM_INDEX

public static final PropID HANDLER_ITEM_INDEX
Unknown purpose


PATH

public static final PropID PATH
Full path, name and extension of the file inside the archive. Example. 'dir/file.ext'. Use File.separator for better cross-platform compatibility. 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.

Type: String. null will be returned, if current archive type doesn't support this property.


NAME

public static final PropID NAME
In IArchiveOpenCallback: Name of the volume to get


EXTENSION

public static final PropID EXTENSION

IS_FOLDER

public static final PropID IS_FOLDER
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.

Type: Boolean. true if item is a folder, otherwise false. Boolean.FALSE is returned, if archive format doesn't support this property. This property is never null.


SIZE

public static final PropID SIZE
Size of the original file. -1 is returned, if no size known for this item. Type: Long null will be returned, if current archive type doesn't support this property.


PACKED_SIZE

public static final PropID PACKED_SIZE
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.

Type: Long null will be returned, if current archive type doesn't support this property.


ATTRIBUTES

public static final PropID ATTRIBUTES
Archive item or file attributes. See PropID.AttributesBitMask for the supported bit masks.

Type: Integer null will be returned, if current archive type doesn't support this property.

Compression: The flag PropID.AttributesBitMask.FILE_ATTRIBUTE_DIRECTORY should be consistent with the IOutItem7z.getPropertyIsDir() property.


CREATION_TIME

public static final PropID CREATION_TIME
Date and time of the file creation.

Type: Date null will be returned, if current archive type doesn't support this property.


LAST_ACCESS_TIME

public static final PropID LAST_ACCESS_TIME
Date and time of last access of the file.

Type: Date null will be returned, if current archive type doesn't support this property.


LAST_MODIFICATION_TIME

public static final PropID LAST_MODIFICATION_TIME
Date and time the file was last time modified.

Type: Date null will be returned, if current archive type doesn't support this property.


SOLID

public static final PropID SOLID

COMMENTED

public static final PropID COMMENTED

ENCRYPTED

public static final PropID ENCRYPTED
Flag either a item encrypted or not.

Type: Boolean. true if item is encrypted, otherwise false. Boolean.FALSE is returned, if archive format doesn't support this property. This property is never null.


SPLIT_BEFORE

public static final PropID SPLIT_BEFORE

SPLIT_AFTER

public static final PropID SPLIT_AFTER

DICTIONARY_SIZE

public static final PropID DICTIONARY_SIZE

CRC

public static final PropID CRC

TYPE

public static final PropID TYPE

IS_ANTI

public static final PropID IS_ANTI
If true delete corresponding file or directory during extraction. Supported only by ArchiveFormat.SEVEN_ZIP.

Type: Boolean null will be returned, if current archive type doesn't support this property.


METHOD

public static final PropID METHOD

HOST_OS

public static final PropID HOST_OS

FILE_SYSTEM

public static final PropID FILE_SYSTEM

USER

public static final PropID USER
User (owner) of the file.

Type: String null will be returned, if current archive type doesn't support this property.


GROUP

public static final PropID GROUP
Group (owner) of the file.

Type: String null will be returned, if current archive type doesn't support this property.


BLOCK

public static final PropID BLOCK

COMMENT

public static final PropID COMMENT

POSITION

public static final PropID POSITION

PREFIX

public static final PropID PREFIX

NUM_SUB_DIRS

public static final PropID NUM_SUB_DIRS

NUM_SUB_FILES

public static final PropID NUM_SUB_FILES

UNPACK_VER

public static final PropID UNPACK_VER

VOLUME

public static final PropID VOLUME

IS_VOLUME

public static final PropID IS_VOLUME

OFFSET

public static final PropID OFFSET

LINKS

public static final PropID LINKS

NUM_BLOCKS

public static final PropID NUM_BLOCKS

NUM_VOLUMES

public static final PropID NUM_VOLUMES

TIME_TYPE

public static final PropID TIME_TYPE

BIT64

public static final PropID BIT64

BIG_ENDIAN

public static final PropID BIG_ENDIAN

CPU

public static final PropID CPU

PHY_SIZE

public static final PropID PHY_SIZE

HEADERS_SIZE

public static final PropID HEADERS_SIZE

CHECKSUM

public static final PropID CHECKSUM

CHARACTS

public static final PropID CHARACTS

VA

public static final PropID VA

ID

public static final PropID ID

SHORT_NAME

public static final PropID SHORT_NAME

CREATOR_APP

public static final PropID CREATOR_APP

SECTOR_SIZE

public static final PropID SECTOR_SIZE

POSIX_ATTRIB

public static final PropID POSIX_ATTRIB
Posix attributes.

Type: Integer null will be returned, if current archive type doesn't support this property.


LINK

public static final PropID LINK

TOTAL_SIZE

public static final PropID TOTAL_SIZE

FREE_SPACE

public static final PropID FREE_SPACE

CLUSTER_SIZE

public static final PropID CLUSTER_SIZE

VOLUME_NAME

public static final PropID VOLUME_NAME

LOCAL_NAME

public static final PropID LOCAL_NAME

PROVIDER

public static final PropID PROVIDER

USER_DEFINED

public static final PropID USER_DEFINED

UNKNOWN

public static final PropID UNKNOWN
Unknown PropID. This PropID shouldn't be used.

Method Detail

values

public static final PropID[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(PropID c : PropID.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static PropID valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getPropIDIndex

public int getPropIDIndex()
Native index of the property

Returns:
Native index of the property

getPropIDByIndex

public static PropID getPropIDByIndex(int propIDIndex)
Get enumeration element by native property index

Parameters:
propIDIndex - native property index
Returns:
enumeration element