Package com.gengoai.io

Enum Compression

java.lang.Object

java.lang.Enum<Compression>

com.gengoai.io.Compression

All Implemented Interfaces:

Serializable, Comparable<Compression>

public enum Compression
extends Enum<Compression>

Methodologies for compressing and decompressing InputStream and OutputStream

Author:

David B. Bracewell

Enum Constant Summary

Enum Constants

Enum Constant	Description
BZIP2	BZIP2 Compression
GZIP	GZIP Compression
NONE	No Compression
XZ
ZIP

Method Summary

Modifier and Type	Method	Description
abstract OutputStream	compressOutputStream(OutputStream outputStream)	Compress the given OutputStream.
abstract InputStream	decompressInputStream(InputStream inputStream)	Decompresses the given InputStream.
static CompressedInputStream	detect(InputStream is)	Detects the compression of the given InputStream returning a CompressedInputStream that allows for reading from the compressed stream.
static Compression	detectCompression(@NonNull InputStream is)
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

No Compression

ZIP

public static final Compression ZIP

GZIP

public static final Compression GZIP

GZIP Compression

BZIP2

public static final Compression BZIP2

BZIP2 Compression

XZ

public static final Compression XZ

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

detect

public static CompressedInputStream detect(InputStream is)
                                    throws IOException

Detects the compression of the given InputStream returning a CompressedInputStream that allows for reading from the compressed stream.

Parameters:

is - the InputStream to read from

Returns:

the CompressedInputStream

Throws:

IOException - Something went wrong detecting the compression

detectCompression

public static Compression detectCompression(@NonNull
                                            @NonNull InputStream is)
                                     throws IOException

Throws:

IOException

compressOutputStream

public abstract OutputStream compressOutputStream(OutputStream outputStream)
                                           throws IOException

Compress the given OutputStream.

Parameters:

outputStream - the OutputStream to compress

Returns:

An OutputStream that will compress its content using the algorithm associated with this Compression algorithm

Throws:

IOException - Something went wrong wrapping the output stream

decompressInputStream

public abstract InputStream decompressInputStream(InputStream inputStream)
                                           throws IOException

Decompresses the given InputStream.

Parameters:

inputStream - the InputStream to decompress

Returns:

An InputStream that will decompress its content using the algorithm associated with this Compression algorithm

Throws:

IOException - Something went wrong wrapping the input stream