Package cnuphys.magfield

Enum Class AngularUnit

java.lang.Object

java.lang.Enum<AngularUnit>

cnuphys.magfield.AngularUnit

All Implemented Interfaces:

Serializable, Comparable<AngularUnit>, Constable

public enum AngularUnit
extends Enum<AngularUnit>

Angular units either DEGREES or RADIANS.

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
DEGREES
RADIANS

Method Summary

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

DEGREES

public static final AngularUnit DEGREES

RADIANS

public static final AngularUnit RADIANS

Method Details

values

public static AngularUnit[] 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 AngularUnit 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 AngularUnit fromInt(int val)

Get the angular unit from an integer

Parameters:

val - the integer value

Returns:

the angular unit