org.metafacture.io

Enum FileCompression

java.lang.Object

java.lang.Enum<FileCompression>

org.metafacture.io.FileCompression

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FileCompression>

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

Provides a convenient interface for using stream compressors and decompressors.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO
BZIP2
GZIP
NONE
PACK200
XZ

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_DECOMPRESS_CONCATENATED

Method Summary

Modifier and Type	Method and Description
abstract java.io.OutputStream	createCompressor(java.io.OutputStream writeTo, java.lang.String fileName) Creates a compressor.
java.io.InputStream	createDecompressor(java.io.InputStream readFrom) Creates a decompressor.
abstract java.io.InputStream	createDecompressor(java.io.InputStream readFrom, boolean decompressConcatenated) Creates a decompressor.
static FileCompression	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FileCompression[]	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 FileCompression NONE

AUTO

public static final FileCompression AUTO

BZIP2

public static final FileCompression BZIP2

GZIP

public static final FileCompression GZIP

PACK200

public static final FileCompression PACK200

XZ

public static final FileCompression XZ

Field Detail

DEFAULT_DECOMPRESS_CONCATENATED

public static final boolean DEFAULT_DECOMPRESS_CONCATENATED

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

java.lang.NullPointerException - if the argument is null

createCompressor

public abstract java.io.OutputStream createCompressor(java.io.OutputStream writeTo,
                                                      java.lang.String fileName)

Creates a compressor.

Parameters:

writeTo - the OutputStream to write to

fileName - the filename

Returns:

the OutputStream

createDecompressor

public abstract java.io.InputStream createDecompressor(java.io.InputStream readFrom,
                                                       boolean decompressConcatenated)

Creates a decompressor.

Parameters:

readFrom - {the @link InputStream} to read from.

decompressConcatenated - true if decompress concatenated, otherwise false

Returns:

the InputStream

createDecompressor

public java.io.InputStream createDecompressor(java.io.InputStream readFrom)

Creates a decompressor.

Parameters:

readFrom - {the @link InputStream} to read from.

Returns:

the InputStream