net.sf.sevenzipjbinding
Enum ArchiveFormat

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

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

Enumeration of all supported archive types.

Format extraction compression Enum value
7z X X SEVEN_ZIP
Arj X - ARJ
BZip2 X X BZIP2
Cab X - CAB
Chm X - CHM
Compound - - -
Cpio X - CPIO
Deb X - DEB
Dmg - - -
Elf - - -
GZip X X GZIP
Hfs - - -
Iso X - ISO
Lzh X - LZH
Lzma X - LZMA
Macho - - -
Mub - - -
Nsis X - NSIS
Pa - - -
Rar X - RAR
Rpm X - RAR
Split - - -
Tar X X TAR
Udf X - UDF
Wim X - WIM
Xar X - XAR
Z X - Z
Zip X X ZIP

Since:
1.0
Author:
Boris Brodski

Enum Constant Summary
ARJ
          Arj format
BZIP2
          BZip2 format.
CAB
          Cab format.
CHM
          Chm
CPIO
          Cpio format.
DEB
          Deb
GZIP
          Gzip format
HFS
          Hfs format
ISO
          Iso format.
LZH
          Lzh
LZMA
          Lzma format.
NSIS
          Nsis
RAR
          Rar format.
RPM
          Rpm
SEVEN_ZIP
          7z format.
SPLIT
          Split format.
TAR
          Tar format.
UDF
          Udf
WIM
          Wim
XAR
          Xar
Z
          Z format.
ZIP
          Zip format.
 
Method Summary
 java.lang.String getMethodName()
          Return name of the archive method
 java.lang.Class<? extends OutArchiveImpl<?>> getOutArchiveImplementation()
          Get corresponding implementation class for archive update operations.
 boolean isOutArchiveSupported()
          Return whether this archive type supports creation/update operations
 boolean supportMultipleFiles()
          Return true, if the archive format is capable of compressing or storing multiple files within the archive.
 java.lang.String toString()
          
static ArchiveFormat valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ArchiveFormat[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ZIP

public static final ArchiveFormat ZIP
Zip format.


TAR

public static final ArchiveFormat TAR
Tar format.


SPLIT

public static final ArchiveFormat SPLIT
Split format. TODO Test it


RAR

public static final ArchiveFormat RAR
Rar format.


LZMA

public static final ArchiveFormat LZMA
Lzma format.


ISO

public static final ArchiveFormat ISO
Iso format.


HFS

public static final ArchiveFormat HFS
Hfs format


GZIP

public static final ArchiveFormat GZIP
Gzip format


CPIO

public static final ArchiveFormat CPIO
Cpio format.


BZIP2

public static final ArchiveFormat BZIP2
BZip2 format.


SEVEN_ZIP

public static final ArchiveFormat SEVEN_ZIP
7z format.


Z

public static final ArchiveFormat Z
Z format.


ARJ

public static final ArchiveFormat ARJ
Arj format


CAB

public static final ArchiveFormat CAB
Cab format.


LZH

public static final ArchiveFormat LZH
Lzh


CHM

public static final ArchiveFormat CHM
Chm


NSIS

public static final ArchiveFormat NSIS
Nsis


DEB

public static final ArchiveFormat DEB
Deb


RPM

public static final ArchiveFormat RPM
Rpm


UDF

public static final ArchiveFormat UDF
Udf


WIM

public static final ArchiveFormat WIM
Wim


XAR

public static final ArchiveFormat XAR
Xar

Method Detail

values

public static final ArchiveFormat[] 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(ArchiveFormat c : ArchiveFormat.values())
        System.out.println(c);

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

valueOf

public static ArchiveFormat 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

getMethodName

public java.lang.String getMethodName()
Return name of the archive method

Returns:
name of the archive method

isOutArchiveSupported

public boolean isOutArchiveSupported()
Return whether this archive type supports creation/update operations

Returns:
true - creation/update operations are supported,
false - only archive extraction is supported

getOutArchiveImplementation

public java.lang.Class<? extends OutArchiveImpl<?>> getOutArchiveImplementation()
Get corresponding implementation class for archive update operations.

Returns:
the IOutArchive implementation class

supportMultipleFiles

public boolean supportMultipleFiles()
Return true, if the archive format is capable of compressing or storing multiple files within the archive.

Returns:
true - support multiple files, false support single file or stream

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Enum<ArchiveFormat>