org.jmol.constant

Enum EnumHBondType

java.lang.Object

java.lang.Enum<EnumHBondType>

org.jmol.constant.EnumHBondType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnumHBondType>

public enum EnumHBondType
extends java.lang.Enum<EnumHBondType>

Enum for hydrogen bonding donor/acceptor type

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCEPTOR
DONOR
NOT
UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
static EnumHBondType	getType(Atom atom)
static boolean	isPossibleHBond(EnumHBondType typeA, EnumHBondType typeB)
static EnumHBondType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumHBondType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT

public static final EnumHBondType NOT

ACCEPTOR

public static final EnumHBondType ACCEPTOR

DONOR

public static final EnumHBondType DONOR

UNKNOWN

public static final EnumHBondType UNKNOWN

Method Detail

values

public static EnumHBondType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EnumHBondType c : EnumHBondType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EnumHBondType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getType

public static EnumHBondType getType(Atom atom)

isPossibleHBond

public static boolean isPossibleHBond(EnumHBondType typeA,
                      EnumHBondType typeB)