org.jlab.coda.jevio

Enum DataType

java.lang.Object

java.lang.Enum<DataType>

org.jlab.coda.jevio.DataType

All Implemented Interfaces:

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

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

This an enum used to convert data type numerical values to a more meaningful name. For example, the data type with value 0x20 corresponds to the enum BANK. Mostly this is used for printing. In this version of evio, the ALSOTAGSEGMENT (0x40) value was removed from this enum because the upper 2 bits of a byte containing the datatype are now used to store padding data.

Author:

heddle, timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALSOBANK Bank data container.
ALSOSEGMENT Segment data container.
BANK Bank data container.
CHAR8 Signed 8-bit integer.
CHARSTAR8 String.
COMPOSITE Composite data type.
DOUBLE64 64-bit double.
FLOAT32 32-bit float.
HOLLERIT Hollerit data type used in Composite data.
INT32 Signed 32-bit integer.
LONG64 Signed 64-bit integer.
mVALUE m (8-bit integer) data type used in Composite data.
nVALUE n (16-bit integer) data type used in Composite data.
NVALUE N (32-bit integer) data type used in Composite data.
SEGMENT Segment data container.
SHORT16 Signed 16-bit integer.
TAGSEGMENT Tag segment data container.
UCHAR8 Unsigned 8-bit integer.
UINT32 Unsigned 32-bit integer.
ULONG64 Unsigned 64-bit integer.
UNKNOWN32 Unknown data type.
USHORT16 Unsigned 16-bit integer.

Method Summary

Modifier and Type	Method and Description
static DataType	getDataType(int val) Obtain the enum from the value.
static java.lang.String	getName(int val) Obtain the name from the value.
int	getValue() Get the enum's value.
boolean	isBank() Convenience routine to see if "this" data type is a bank structure.
static boolean	isBank(int dataType) Convenience routine to see if the given integer arg represents a BANK.
boolean	isInteger() Convenience routine to see if "this" data type is an integer of some kind - either 8, 16, 32, or 64 bits worth.
static boolean	isSegment(int dataType) Convenience routine to see if the given integer arg represents a SEGMENT.
boolean	isStructure() Convenience routine to see if "this" data type is a structure (a container.)
static boolean	isStructure(int dataType) Convenience routine to see if the given integer arg represents a data type which is a structure (a container).
static boolean	isTagSegment(int dataType) Convenience routine to see if the given integer arg represents a TAGSEGMENT.
java.lang.String	toString() Return a string which is usually the same as the name of the enumerated value, except in the cases of ALSOSEGMENT and ALSOBANK which return SEGMENT and BANK respectively.
static DataType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN32

public static final DataType UNKNOWN32

Unknown data type.

UINT32

public static final DataType UINT32

Unsigned 32-bit integer.

FLOAT32

public static final DataType FLOAT32

32-bit float.

CHARSTAR8

public static final DataType CHARSTAR8

String.

SHORT16

public static final DataType SHORT16

Signed 16-bit integer.

USHORT16

public static final DataType USHORT16

Unsigned 16-bit integer.

CHAR8

public static final DataType CHAR8

Signed 8-bit integer.

UCHAR8

public static final DataType UCHAR8

Unsigned 8-bit integer.

DOUBLE64

public static final DataType DOUBLE64

64-bit double.

LONG64

public static final DataType LONG64

Signed 64-bit integer.

ULONG64

public static final DataType ULONG64

Unsigned 64-bit integer.

INT32

public static final DataType INT32

Signed 32-bit integer.

TAGSEGMENT

public static final DataType TAGSEGMENT

Tag segment data container.

ALSOSEGMENT

public static final DataType ALSOSEGMENT

Segment data container.

ALSOBANK

public static final DataType ALSOBANK

Bank data container.

COMPOSITE

public static final DataType COMPOSITE

Composite data type.

BANK

public static final DataType BANK

Bank data container.

SEGMENT

public static final DataType SEGMENT

Segment data container.

HOLLERIT

public static final DataType HOLLERIT

Hollerit data type used in Composite data.

NVALUE

public static final DataType NVALUE

N (32-bit integer) data type used in Composite data.

nVALUE

public static final DataType nVALUE

n (16-bit integer) data type used in Composite data.

mVALUE

public static final DataType mVALUE

m (8-bit integer) data type used in Composite data.

Method Detail

values

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

Returns:

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

valueOf

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

getDataType

public static DataType getDataType(int val)

Obtain the enum from the value.

Parameters:

val - the value to match.

Returns:

the matching enum, or null.

getName

public static java.lang.String getName(int val)

Obtain the name from the value.

Parameters:

val - the value to match.

Returns:

the name, or "UNKNOWN".

isStructure

public static boolean isStructure(int dataType)

Convenience routine to see if the given integer arg represents a data type which is a structure (a container).

Parameters:

dataType - data type to examine.

Returns:

true if the data type corresponds to one of the structure types: BANK, SEGMENT, or TAGSEGMENT.

isBank

public static boolean isBank(int dataType)

Convenience routine to see if the given integer arg represents a BANK.

Parameters:

dataType - data type to examine.

Returns:

true if the data type corresponds to a BANK.

isSegment

public static boolean isSegment(int dataType)

Convenience routine to see if the given integer arg represents a SEGMENT.

Parameters:

dataType - data type to examine.

Returns:

true if the data type corresponds to a SEGMENT.

isTagSegment

public static boolean isTagSegment(int dataType)

Convenience routine to see if the given integer arg represents a TAGSEGMENT.

Parameters:

dataType - data type to examine.

Returns:

true if the data type corresponds to a TAGSEGMENT.

getValue

public int getValue()

Get the enum's value.

Returns:

the value, e.g., 0xe for a BANK

toString

public java.lang.String toString()

Return a string which is usually the same as the name of the enumerated value, except in the cases of ALSOSEGMENT and ALSOBANK which return SEGMENT and BANK respectively.

Overrides:

toString in class java.lang.Enum<DataType>

Returns:

name of the enumerated type

isStructure

public boolean isStructure()

Convenience routine to see if "this" data type is a structure (a container.)

Returns:

true if the data type corresponds to one of the structure types: BANK, SEGMENT, or TAGSEGMENT.

isBank

public boolean isBank()

Convenience routine to see if "this" data type is a bank structure.

Returns:

true if this data type corresponds to a bank structure.

isInteger

public boolean isInteger()

Convenience routine to see if "this" data type is an integer of some kind - either 8, 16, 32, or 64 bits worth.

Returns:

true if the data type corresponds to an integer type