Package ffx.numerics

Enum Class Potential.STATE

java.lang.Object

java.lang.Enum<Potential.STATE>

ffx.numerics.Potential.STATE

All Implemented Interfaces:

Serializable, Comparable<Potential.STATE>, Constable

Enclosing interface:

Potential

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

Set the state of the Potential to include FAST varying energy terms, SLOW varying energy terms or BOTH.

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
BOTH	Include both FAST and SLOW varying energy terms.
FAST	Include FAST varying energy terms.
SLOW	Include SLOW varying energy terms.

Method Summary

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

FAST

public static final Potential.STATE FAST

Include FAST varying energy terms.

SLOW

public static final Potential.STATE SLOW

Include SLOW varying energy terms.

BOTH

public static final Potential.STATE BOTH

Include both FAST and SLOW varying energy terms.

Method Details

values

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