Package ffx.potential.bonded

Enum Class RotamerLibrary.ProteinLibrary

java.lang.Object

java.lang.Enum<RotamerLibrary.ProteinLibrary>

ffx.potential.bonded.RotamerLibrary.ProteinLibrary

All Implemented Interfaces:

Serializable, Comparable<RotamerLibrary.ProteinLibrary>, Constable

Enclosing class:

RotamerLibrary

public static enum RotamerLibrary.ProteinLibrary
extends Enum<RotamerLibrary.ProteinLibrary>

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
None
PonderAndRichards
Richardson

Method Summary

Modifier and Type	Method	Description
static RotamerLibrary.ProteinLibrary	getProteinLibrary(String input)	Parses a String input to a ProteinLibrary.
static RotamerLibrary.ProteinLibrary	intToProteinLibrary(int library)	Converts an integer to a corresponding ProteinLibrary.
static RotamerLibrary.ProteinLibrary	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RotamerLibrary.ProteinLibrary[]	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

PonderAndRichards

public static final RotamerLibrary.ProteinLibrary PonderAndRichards

Richardson

public static final RotamerLibrary.ProteinLibrary Richardson

None

public static final RotamerLibrary.ProteinLibrary None

Method Details

values

public static RotamerLibrary.ProteinLibrary[] 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 RotamerLibrary.ProteinLibrary 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

getProteinLibrary

public static RotamerLibrary.ProteinLibrary getProteinLibrary(String input)
                                                       throws IllegalArgumentException

Parses a String input to a ProteinLibrary. Can be either a name, or an integer constant.

The name is preferred, but the integer constant is allowed for legacy reasons.

Parameters:

input - Input to parse.

Returns:

A ProteinLibrary.

Throws:

IllegalArgumentException - If no matching ProteinLibrary found.

intToProteinLibrary

public static RotamerLibrary.ProteinLibrary intToProteinLibrary(int library)
                                                         throws IllegalArgumentException

Converts an integer to a corresponding ProteinLibrary.

Parameters:

library - Index of the library.

Returns:

A ProteinLibrary.

Throws:

IllegalArgumentException - If no matching ProteinLibrary found.