org.javaseis.properties
Enum DataFormat

java.lang.Object
  java.lang.Enum<DataFormat>
      org.javaseis.properties.DataFormat

All Implemented Interfaces:

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

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

The DataFormat class provides JavaSeis data format enumerations.

Enum Constant Summary

COMPRESSED_INT08

COMPRESSED_INT16

FLOAT

INT08

INT16

Field Summary

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

Method Summary

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

COMPRESSED_INT08

public static final DataFormat COMPRESSED_INT08

COMPRESSED_INT16

public static final DataFormat COMPRESSED_INT16

FLOAT

public static final DataFormat FLOAT

INT08

public static final DataFormat INT08

INT16

public static final DataFormat INT16

Field Detail

_bytesPerSample

protected int _bytesPerSample

_description

protected java.lang.String _description

_name

protected java.lang.String _name

Method Detail

get

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

Gets the data format based on the name.

Parameters:

name - The name of the data format.

Returns:

The data format.

getBytesPerSample

public int getBytesPerSample()

Gets the # of bytes per sample the data format.

Returns:

The # of bytes per sample of the data format.

getDescription

public java.lang.String getDescription()

Gets the description the data format.

Returns:

The description of the data format.

getName

public java.lang.String getName()

Gets the name the data format.

Returns:

The name of the data format.

toString

public java.lang.String toString()

Gets the string representation of the data format.

Overrides:

toString in class java.lang.Enum<DataFormat>

Returns:

The string representation.

valueOf

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

Returns:

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