Enum Class ThermodynamicsOptions.ThermodynamicsAlgorithm

java.lang.Object

java.lang.Enum<ThermodynamicsOptions.ThermodynamicsAlgorithm>

ffx.algorithms.cli.ThermodynamicsOptions.ThermodynamicsAlgorithm

All Implemented Interfaces:

Serializable, Comparable<ThermodynamicsOptions.ThermodynamicsAlgorithm>, Constable

Enclosing class:

ThermodynamicsOptions

public static enum ThermodynamicsOptions.ThermodynamicsAlgorithm
extends Enum<ThermodynamicsOptions.ThermodynamicsAlgorithm>

Represents categories of thermodynamics algorithms that must be handled differently.

Since:

1.0

Author:

Michael J. Schnieders, Jacob M. Litman

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIXED
NEQ
OST

Method Summary

Modifier and Type	Method	Description
static ThermodynamicsOptions.ThermodynamicsAlgorithm	parse(String name)	Parse a String to a corresponding thermodynamics algorithm, recognizing aliases.
static ThermodynamicsOptions.ThermodynamicsAlgorithm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ThermodynamicsOptions.ThermodynamicsAlgorithm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OST

public static final ThermodynamicsOptions.ThermodynamicsAlgorithm OST

FIXED

public static final ThermodynamicsOptions.ThermodynamicsAlgorithm FIXED

NEQ

public static final ThermodynamicsOptions.ThermodynamicsAlgorithm NEQ

Method Details

values

public static ThermodynamicsOptions.ThermodynamicsAlgorithm[] 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 ThermodynamicsOptions.ThermodynamicsAlgorithm 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

parse

public static ThermodynamicsOptions.ThermodynamicsAlgorithm parse(String name)
                                                           throws IllegalArgumentException

Parse a String to a corresponding thermodynamics algorithm, recognizing aliases.

Parameters:

name - Name to parse

Returns:

A ThermodynamicsAlgorithm.

Throws:

IllegalArgumentException - If name did not correspond to any alias of any ThermodynamicsAlgorithm.