Package ffx.numerics

Enum Class Potential.VARIABLE_TYPE

java.lang.Object

java.lang.Enum<Potential.VARIABLE_TYPE>

ffx.numerics.Potential.VARIABLE_TYPE

All Implemented Interfaces:

Serializable, Comparable<Potential.VARIABLE_TYPE>, Constable

Enclosing interface:

Potential

public static enum Potential.VARIABLE_TYPE
extends Enum<Potential.VARIABLE_TYPE>

Recognized variables currently include Cartesian coordinates and OTHER.

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
OTHER
X
Y
Z

Method Summary

Modifier and Type	Method	Description
static Potential.VARIABLE_TYPE	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Potential.VARIABLE_TYPE[]	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

X

public static final Potential.VARIABLE_TYPE X

Y

public static final Potential.VARIABLE_TYPE Y

Z

public static final Potential.VARIABLE_TYPE Z

OTHER

public static final Potential.VARIABLE_TYPE OTHER

Method Details

values

public static Potential.VARIABLE_TYPE[] 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 Potential.VARIABLE_TYPE 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