Package org.deltava.beans

Enum Class Compression

java.lang.Object

java.lang.Enum<Compression>

org.deltava.beans.Compression

All Implemented Interfaces:

Serializable, Comparable<Compression>, Constable

public enum Compression
extends Enum<Compression>

An enumeration of file compression types.

Since:

10.3

Version:

10.6

Author:

Luke

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BROTLI
BZIP2
GZIP
NONE
XZ

Method Summary

Modifier and Type	Method	Description
static Compression	detect(File f)	Detects the compression format of a File.
static Compression	get(String fileName)	Returns the compression type for a given file name.
InputStream	getStream(InputStream is)	Returns a compressed input stream for a particular compression type.
static Compression	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Compression[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final Compression NONE

GZIP

public static final Compression GZIP

BZIP2

public static final Compression BZIP2

BROTLI

public static final Compression BROTLI

XZ

public static final Compression XZ

Method Details

values

public static Compression[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Compression valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

get

public static Compression get(String fileName)

Returns the compression type for a given file name.

Parameters:

fileName - the file name

Returns:

a CompressionType

getStream

public InputStream getStream(InputStream is)
                      throws IOException

Returns a compressed input stream for a particular compression type.

Parameters:

is - the raw InputStream

Returns:

a decompressor InputStream for this compression type

Throws:

IOException - if an I/O error occurs

detect

public static Compression detect(File f)
                          throws IOException

Detects the compression format of a File. Note that there is no standardized magic number for Brotli compressed streams.

Parameters:

f - a File

Returns:

a Compression type

Throws:

IOException - if an I/O error occurs