org.vafer.jdeb

Enum Compression

java.lang.Object

java.lang.Enum<Compression>

org.vafer.jdeb.Compression

All Implemented Interfaces:

Serializable, Comparable<Compression>

public enum Compression
extends Enum<Compression>

Compression method used for the data file.

Author:

Emmanuel Bourg

Enum Constant Summary

Enum Constants

Enum Constant and Description
BZIP2
GZIP
NONE

Method Summary

Methods

Modifier and Type	Method and Description
String	getExtension() Returns the extension of the compression method
OutputStream	toCompressedOutputStream(OutputStream out)
static Compression	toEnum(String name) Returns the compression method corresponding to the specified name.
static Compression	valueOf(String name) Returns the enum constant of this type with the specified name.
static Compression[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Compression NONE

GZIP

public static final Compression GZIP

BZIP2

public static final Compression BZIP2

Method Detail

values

public static Compression[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Compression c : Compression.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Compression valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getExtension

public String getExtension()

Returns the extension of the compression method

toCompressedOutputStream

public OutputStream toCompressedOutputStream(OutputStream out)
                                      throws org.apache.commons.compress.compressors.CompressorException

Throws:

org.apache.commons.compress.compressors.CompressorException

toEnum

public static Compression toEnum(String name)

Returns the compression method corresponding to the specified name. The matching is case insensitive.

Parameters:

name - the name of the compression method

Returns:

the compression method, or null if not recognized