|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<ArmAxis>
net.talvi.puffinplot.data.ArmAxis
public enum ArmAxis
ArmAxis represents the axis along which an ARM (anhysteretic remanent magnetization) field has been applied.
Enum Constant Summary | |
---|---|
AXIAL
an ARM axis lying along the axis of the magnetometer |
|
NONE
no ARM was applied |
|
UNKNOWN
the ARM axis is unknown, or cannot be represented by this enum |
Method Summary | |
---|---|
static ArmAxis |
fromString(java.lang.String name)
Creates an ArmAxis from the supplied string. |
static ArmAxis |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static ArmAxis[] |
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 |
---|
public static final ArmAxis AXIAL
public static final ArmAxis NONE
public static final ArmAxis UNKNOWN
Method Detail |
---|
public static ArmAxis[] values()
for (ArmAxis c : ArmAxis.values()) System.out.println(c);
public static ArmAxis valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic static ArmAxis fromString(java.lang.String name)
Creates an ArmAxis
from the supplied string. The values
produced are as follows:
Input | Result |
---|---|
AXIAL | AXIAL |
NONE | NONE |
NA | NONE |
[any other string] | UNKNOWN |
name
- a string specifying the ARM axis
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |