org.jlab.coda.jevio

Enum StructureType

java.lang.Object

java.lang.Enum<StructureType>

org.jlab.coda.jevio.StructureType

All Implemented Interfaces:

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

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

This an enum used to convert structure type numerical values to a more meaningful name. For example, the structure type with value 0xe corresponds to the enum BANK. Mostly this is used for printing.

Author:

heddle, timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
BANK Bank structure.
SEGMENT Segment structure.
TAGSEGMENT Tag segment structure.
UNKNOWN32 Unknown structure.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getName(int val) Obtain the name from the value.
static StructureType	getStructureType(int val) Obtain the enum from the value.
int	getValue() Get the enum's value.
static StructureType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StructureType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN32

public static final StructureType UNKNOWN32

Unknown structure.

TAGSEGMENT

public static final StructureType TAGSEGMENT

Tag segment structure.

SEGMENT

public static final StructureType SEGMENT

Segment structure.

BANK

public static final StructureType BANK

Bank structure.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the enum's value.

Returns:

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

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".

getStructureType

public static StructureType getStructureType(int val)

Obtain the enum from the value.

Parameters:

val - the value to match.

Returns:

the matching enum, or null.