org.jlab.coda.hipo

Enum HeaderType

java.lang.Object

java.lang.Enum<HeaderType>

org.jlab.coda.hipo.HeaderType

All Implemented Interfaces:

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

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

Numerical values associated with types of record headers, file headers and trailers. The value associated with each enum member is stored in the header's bit-info word in the top 4 bits.

Since:

6.0 9/6/17

Version:

6.0

Author:

timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVIO_FILE Evio file header.
EVIO_FILE_EXTENDED Evio extended file header.
EVIO_RECORD Evio record header.
EVIO_TRAILER Evio trailer.
HIPO_FILE Hipo file header.
HIPO_FILE_EXTENDED Hipo extended file header.
HIPO_RECORD Hioo record header.
HIPO_TRAILER Hipo trailer.

Method Summary

Modifier and Type	Method and Description
static HeaderType	getHeaderType(int val) Get the enum from the integer value.
static java.lang.String	getName(int val) Get the name from the integer value.
(package private) int	getValue() Get the integer value associated with this header type.
boolean	isEvioFileHeader() Is this an evio file header?
boolean	isFileHeader() Is this a file header?
boolean	isHipoFileHeader() Is this a HIPO file header?
boolean	isTrailer() Is this a trailer?
static HeaderType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HeaderType[]	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

EVIO_RECORD

public static final HeaderType EVIO_RECORD

Evio record header.

EVIO_FILE

public static final HeaderType EVIO_FILE

Evio file header.

EVIO_FILE_EXTENDED

public static final HeaderType EVIO_FILE_EXTENDED

Evio extended file header.

EVIO_TRAILER

public static final HeaderType EVIO_TRAILER

Evio trailer.

HIPO_RECORD

public static final HeaderType HIPO_RECORD

Hioo record header.

HIPO_FILE

public static final HeaderType HIPO_FILE

Hipo file header.

HIPO_FILE_EXTENDED

public static final HeaderType HIPO_FILE_EXTENDED

Hipo extended file header.

HIPO_TRAILER

public static final HeaderType HIPO_TRAILER

Hipo trailer.

Method Detail

values

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

Returns:

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

valueOf

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

int getValue()

Get the integer value associated with this header type.

Returns:

integer value associated with this header type.

isEvioFileHeader

public boolean isEvioFileHeader()

Is this an evio file header?

Returns:

true if is an evio file header, else false

isHipoFileHeader

public boolean isHipoFileHeader()

Is this a HIPO file header?

Returns:

true if is an HIPO file header, else false

isFileHeader

public boolean isFileHeader()

Is this a file header?

Returns:

true if is a file header, else false

isTrailer

public boolean isTrailer()

Is this a trailer?

Returns:

true if is a trailer, else false

getHeaderType

public static HeaderType getHeaderType(int val)

Get the enum from the integer value.

Parameters:

val - the value to match.

Returns:

the matching enum, or null.

getName

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

Get the name from the integer value.

Parameters:

val - the value to match.

Returns:

the name, or null.