Enum Class DetectorId

java.lang.Object

java.lang.Enum<DetectorId>

org.jlab.geom.DetectorId

All Implemented Interfaces:

Serializable, Comparable<DetectorId>, Constable, Showable

public enum DetectorId
extends Enum<DetectorId>
implements Showable

The unique identifier of a type of detector. DetectorId is an enumeration to ensure that within the geometry package there are can be no ambiguity about what kind of detector is being referenced by a DetectorId. DetectorId also associates an id number and a short String name with each type of detector. Detector id numbers are loosely based on the CLAS12 Bank Numbering scheme. UNDEFINED is used to that there is no such detector could be found via whatever mechanism was being used to retrieve a DetectorId (e.g. getId(java.lang.String)}).

Author:

jnhankins

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
AHDC
ATOF
BST
CND
CTOF
DC
EC
FMT
FTCAL
FTOF
RICH
UNDEFINED

Method Summary

Modifier and Type	Method	Description
static DetectorId	getId(int number)	Returns the DetectorId corresponding to the given id number or UNDEFINED if no DetectorId matches the given id number.
static DetectorId	getId(String name)	Returns the DetectorId corresponding to the given name or UNDEFINED if no DetectorId matches the given name.
int	getIdNumber()	Returns the id number of the detector.
String	getName()	Returns the name of the detector.
void	show()	Invokes System.out.println(this).
String	toString()
static DetectorId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DetectorId[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNDEFINED

public static final DetectorId UNDEFINED

BST

public static final DetectorId BST

CND

public static final DetectorId CND

RICH

public static final DetectorId RICH

FMT

public static final DetectorId FMT

FTCAL

public static final DetectorId FTCAL

CTOF

public static final DetectorId CTOF

FTOF

public static final DetectorId FTOF

DC

public static final DetectorId DC

EC

public static final DetectorId EC

AHDC

public static final DetectorId AHDC

ATOF

public static final DetectorId ATOF

Method Details

values

public static DetectorId[] 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 DetectorId 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

getIdNumber

public int getIdNumber()

Returns the id number of the detector.

Returns:

the id number of the detector

getName

public String getName()

Returns the name of the detector.

Returns:

the name of the detector

show

public void show()

Invokes System.out.println(this).

Specified by:

show in interface Showable

toString

public String toString()

Overrides:

toString in class Enum<DetectorId>

getId

public static DetectorId getId(String name)

Returns the DetectorId corresponding to the given name or UNDEFINED if no DetectorId matches the given name.

Parameters:

name - the name of the DetectrId to find

Returns:

the corresponding DetectorId or UNDIFIED if not found

getId

public static DetectorId getId(int number)

Returns the DetectorId corresponding to the given id number or UNDEFINED if no DetectorId matches the given id number.

Parameters:

number - the id number of the the DetectrId to find

Returns:

the corresponding DetectorId or UNDIFIED if not found