org.javaseis.compress
Enum DataCompression

java.lang.Object
  java.lang.Enum<DataCompression>
      org.javaseis.compress.DataCompression

All Implemented Interfaces:

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

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

The DataCompression class provides JavaSeis data compression enumerations.

Enum Constant Summary

INT08

INT16

NONE

Field Summary

protected int	_bytesPerSample
protected java.lang.String	_description
protected java.lang.String	_name

Method Summary

static DataCompression	get(java.lang.String name) Gets the data compression based on the name.
int	getBytesPerSample() Gets the # of bytes per sample the data compression.
java.lang.String	getDescription() Gets the description the data compression.
java.lang.String	getName() Gets the name the data compression.
java.lang.String	toString() Gets the string representation of the data compression.
static DataCompression	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataCompression[]	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

INT08

public static final DataCompression INT08

INT16

public static final DataCompression INT16

NONE

public static final DataCompression NONE

Field Detail

_bytesPerSample

protected int _bytesPerSample

_description

protected java.lang.String _description

_name

protected java.lang.String _name

Method Detail

get

public static DataCompression get(java.lang.String name)

Gets the data compression based on the name.

Parameters:

name - The name of the data compression.

Returns:

The data compression.

getBytesPerSample

public int getBytesPerSample()

Gets the # of bytes per sample the data compression.

Returns:

The # of bytes per sample of the data compression.

getDescription

public java.lang.String getDescription()

Gets the description the data compression.

Returns:

The description of the data compression.

getName

public java.lang.String getName()

Gets the name the data compression.

Returns:

The name of the data compression.

toString

public java.lang.String toString()

Gets the string representation of the data compression.

Overrides:

toString in class java.lang.Enum<DataCompression>

Returns:

The string representation.

valueOf

public static DataCompression 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

values

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

Returns:

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