Package cnuphys.magfield

Enum Class LengthUnit

java.lang.Object

java.lang.Enum<LengthUnit>

cnuphys.magfield.LengthUnit

All Implemented Interfaces:

Serializable, Comparable<LengthUnit>, Constable

public enum LengthUnit
extends Enum<LengthUnit>

Length unit, either CM or M. These are for lengths in field map files.

Version:

1.0

Author:

David Heddle, Nicole Schumacher

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
CM
M

Method Summary

Modifier and Type	Method	Description
static LengthUnit	fromInt(int val)	Get the length unit from an integer
static LengthUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LengthUnit[]	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

CM

public static final LengthUnit CM

M

public static final LengthUnit M

Method Details

values

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

fromInt

public static LengthUnit fromInt(int val)

Get the length unit from an integer

Parameters:

val - the integer value

Returns:

the length unit