Enum Class HelicityBit

java.lang.Object

java.lang.Enum<HelicityBit>

org.jlab.detector.helicity.HelicityBit

All Implemented Interfaces:

Serializable, Comparable<HelicityBit>, Constable

public enum HelicityBit
extends Enum<HelicityBit>

Just to force a convention and avoid confusion on helicity bit definitions. These numeric values are also what goes in data banks.

Author:

baltzell

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DNE
MINUS
PLUS
UDF

Method Summary

Modifier and Type	Method	Description
static HelicityBit	create(byte value)
static HelicityBit	createFromRawBit(byte bit)
static HelicityBit	getFlipped(HelicityBit bit)
byte	value()
static HelicityBit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HelicityBit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DNE

public static final HelicityBit DNE

UDF

public static final HelicityBit UDF

PLUS

public static final HelicityBit PLUS

MINUS

public static final HelicityBit MINUS

Method Details

values

public static HelicityBit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HelicityBit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public byte value()

create

public static HelicityBit create(byte value)

getFlipped

public static HelicityBit getFlipped(HelicityBit bit)

createFromRawBit

public static HelicityBit createFromRawBit(byte bit)