Package ffx.potential.bonded

Enum Class NamingUtils.HetAtoms

java.lang.Object

java.lang.Enum<NamingUtils.HetAtoms>

ffx.potential.bonded.NamingUtils.HetAtoms

All Implemented Interfaces:

Serializable, Comparable<NamingUtils.HetAtoms>, Constable

Enclosing class:

NamingUtils

public static enum NamingUtils.HetAtoms
extends Enum<NamingUtils.HetAtoms>

Common HETATOM labels for water and ions.

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
BR
CA
CA2
CL
H2O
HOH
K
MG
MG2
NA
WAT
ZN
ZN2

Method Summary

Modifier and Type	Method	Description
static NamingUtils.HetAtoms	parse(String str)	Slightly more robust parsing function that ignores case and trailing numbers, -, and +
static NamingUtils.HetAtoms	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NamingUtils.HetAtoms[]	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

BR

public static final NamingUtils.HetAtoms BR

CA

public static final NamingUtils.HetAtoms CA

CA2

public static final NamingUtils.HetAtoms CA2

CL

public static final NamingUtils.HetAtoms CL

K

public static final NamingUtils.HetAtoms K

MG

public static final NamingUtils.HetAtoms MG

MG2

public static final NamingUtils.HetAtoms MG2

NA

public static final NamingUtils.HetAtoms NA

HOH

public static final NamingUtils.HetAtoms HOH

H2O

public static final NamingUtils.HetAtoms H2O

WAT

public static final NamingUtils.HetAtoms WAT

ZN

public static final NamingUtils.HetAtoms ZN

ZN2

public static final NamingUtils.HetAtoms ZN2

Method Details

values

public static NamingUtils.HetAtoms[] 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 NamingUtils.HetAtoms 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 NamingUtils.HetAtoms parse(String str)

Slightly more robust parsing function that ignores case and trailing numbers, -, and +

Parameters:

str - String to parse

Returns:

Corresponding HetAtoms value.