com.cloudhopper.commons.util

Enum CompressionUtil.Algorithm

java.lang.Object

java.lang.Enum<CompressionUtil.Algorithm>

com.cloudhopper.commons.util.CompressionUtil.Algorithm

All Implemented Interfaces:

Serializable, Comparable<CompressionUtil.Algorithm>

Enclosing class:

CompressionUtil

public static enum CompressionUtil.Algorithm
extends Enum<CompressionUtil.Algorithm>

Enumeration of all supported compression algorithms by this utility.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GZIP gzip
ZIP zip

Method Summary

Methods

Modifier and Type	Method and Description
static CompressionUtil.Algorithm	findByFileExtension(String fileExt) Finds the matching compression algorithm by performing a case insensitive search based on its file extension such as "gz" for gzip.
static CompressionUtil.Algorithm	findByName(String name) Finds the matching compression algorithm by performing a case insensitive search based on its name such as "gzip".
String	getFileExtension() Gets the extension associated with this compression algorithm such as "gz" for gzip or "zip" for zip.
String	getName() Gets the name of this compression algorithm such as "gzip".
static CompressionUtil.Algorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompressionUtil.Algorithm[]	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

GZIP

public static final CompressionUtil.Algorithm GZIP

gzip

ZIP

public static final CompressionUtil.Algorithm ZIP

zip

Method Detail

values

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

Returns:

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

valueOf

public static CompressionUtil.Algorithm 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

getName

public String getName()

Gets the name of this compression algorithm such as "gzip".

Returns:

The name of this compression algorithm

getFileExtension

public String getFileExtension()

Gets the extension associated with this compression algorithm such as "gz" for gzip or "zip" for zip.

Returns:

The compression algorithm file extension

findByName

public static CompressionUtil.Algorithm findByName(String name)

Finds the matching compression algorithm by performing a case insensitive search based on its name such as "gzip".

Parameters:

name - The algorithm name such as "gzip" or "zip"

Returns:

The matching algorithm or null if no algorithm was found

findByFileExtension

public static CompressionUtil.Algorithm findByFileExtension(String fileExt)

Finds the matching compression algorithm by performing a case insensitive search based on its file extension such as "gz" for gzip.

Parameters:

name - The algorithm file extension such as "gz" or "zip"

Returns:

The matching algorithm or null if no algorithm was found