Enum Class XYZUnits

java.lang.Object

java.lang.Enum<XYZUnits>

com.xinapse.multisliceimage.analyze.XYZUnits

All Implemented Interfaces:

Serializable, Comparable<XYZUnits>, Constable

public enum XYZUnits
extends Enum<XYZUnits>

This class represents the NIFTI units of length.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
METRE	Length units of metres.
MICRON	Length units of microns.
MM	Length units of mm.
UNKNOWN	Unknown length units.

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Run a self-test on the XYZUnits class.
String	toString()	Returns a string describing this XYZUnits.
static XYZUnits	valueOf(String name)	Returns the enum constant of this class with the specified name.
static XYZUnits[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final XYZUnits UNKNOWN

Unknown length units. Assume mm by default.

METRE

public static final XYZUnits METRE

Length units of metres.

MM

public static final XYZUnits MM

Length units of mm.

MICRON

public static final XYZUnits MICRON

Length units of microns.

Method Details

values

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

toString

public String toString()

Returns a string describing this XYZUnits.

Overrides:

toString in class Enum<XYZUnits>

Returns:

a string describing this XYZUnits.

main

public static void main(String[] args)

Run a self-test on the XYZUnits class.

Parameters:

args - ignored.