org.kitesdk.data

Enum CompressionType

java.lang.Object

java.lang.Enum<CompressionType>

org.kitesdk.data.CompressionType

All Implemented Interfaces:

Serializable, Comparable<CompressionType>

public enum CompressionType
extends Enum<CompressionType>

Contains constant definitions for the standard compression types we support. Not every Format supports every compression type. Use Format.getSupportedCompressionTypes() to see what compression types your Format supports.

Since:

0.17.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
Bzip2
Deflate
Lzo
Snappy
Uncompressed

Method Summary

Methods

Modifier and Type	Method and Description
static CompressionType	forName(String name) Return a CompressionType for the compression type name specified.
String	getName() Get the String name for this compression type.
String	toString()
static CompressionType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CompressionType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Snappy

public static final CompressionType Snappy

Deflate

public static final CompressionType Deflate

Bzip2

public static final CompressionType Bzip2

Lzo

public static final CompressionType Lzo

Uncompressed

public static final CompressionType Uncompressed

Method Detail

values

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

Returns:

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

valueOf

public static CompressionType 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()

Get the String name for this compression type. This name can be passed to forName(java.lang.String) to return this instance.

Returns:

the name of the compression type

toString

public String toString()

Overrides:

toString in class Enum<CompressionType>

forName

public static CompressionType forName(String name)

Return a CompressionType for the compression type name specified. If name is not a valid name, an IllegalArgumentException is thrown. Current the compression types snappy, deflate, bzip2, and lzo are supported. Not all compression types are supported by all Formats.

Parameters:

name - the name of the compression type

Returns:

the appropriate CompressionType

Throws:

IllegalArgumentException - if name is not a valid compression type.