org.jlab.coda.hipo

Enum CompressionType

java.lang.Object

java.lang.Enum<CompressionType>

org.jlab.coda.hipo.CompressionType

All Implemented Interfaces:

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

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

This an enum used to represent different types of data compression.

Author:

timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
RECORD_COMPRESSION_GZIP Data compression using gzip method.
RECORD_COMPRESSION_LZ4 Data compression using fastest LZ4 method.
RECORD_COMPRESSION_LZ4_BEST Data compression using slowest but most compact LZ4 method.
RECORD_UNCOMPRESSED No data compression.

Method Summary

Modifier and Type	Method and Description
static CompressionType	getCompressionType(int val) Get the enum from the integer value.
java.lang.String	getDescription() Get the description.
(package private) int	getValue() Get the integer value associated with this header type.
boolean	isCompressed() Is this a form of compression?
static CompressionType	valueOf(java.lang.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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RECORD_UNCOMPRESSED

public static final CompressionType RECORD_UNCOMPRESSED

No data compression.

RECORD_COMPRESSION_LZ4

public static final CompressionType RECORD_COMPRESSION_LZ4

Data compression using fastest LZ4 method.

RECORD_COMPRESSION_LZ4_BEST

public static final CompressionType RECORD_COMPRESSION_LZ4_BEST

Data compression using slowest but most compact LZ4 method.

RECORD_COMPRESSION_GZIP

public static final CompressionType RECORD_COMPRESSION_GZIP

Data compression using gzip method.

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(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

getDescription

public java.lang.String getDescription()

Get the description.

Returns:

description.

getValue

int getValue()

Get the integer value associated with this header type.

Returns:

integer value associated with this header type.

isCompressed

public boolean isCompressed()

Is this a form of compression?

Returns:

true if is a form of compression, else false

getCompressionType

public static CompressionType getCompressionType(int val)

Get the enum from the integer value.

Parameters:

val - the value to match.

Returns:

the matching enum, or null.