org.proteinshader.structure.enums
Enum ResidueEnum

java.lang.Object
  java.lang.Enum<ResidueEnum>
      org.proteinshader.structure.enums.ResidueEnum

All Implemented Interfaces:

Serializable, Comparable<ResidueEnum>

public enum ResidueEnum
extends Enum<ResidueEnum>

Provides an enumeration that can be used to restrict a Visitor to traversing only a particular Residue type.

Enum Constant Summary

AA_AND_WATERS
Visit AminoAcids first and then visit Waters.

AA_BACKBONE
Visit only AminoAcids, and then visit only the backbone Atoms.

AA_SIDE_CHAIN
Visit only AminoAcids, and then visit only the side chain Atoms.

AMINO_ACIDS
Visit only AminoAcids.

HETEROGENS
Visit only Heterogens.

WATERS
Visit only Waters.

Method Summary

String	toString() Returns the Residue type as a String suitable for use in a menu: for example, "Amino Acids" rather then "AMINO_ACIDS".
static ResidueEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResidueEnum[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AMINO_ACIDS

public static final ResidueEnum AMINO_ACIDS

Visit only AminoAcids.

AA_BACKBONE

public static final ResidueEnum AA_BACKBONE

Visit only AminoAcids, and then visit only the backbone Atoms.

AA_SIDE_CHAIN

public static final ResidueEnum AA_SIDE_CHAIN

Visit only AminoAcids, and then visit only the side chain Atoms.

AA_AND_WATERS

public static final ResidueEnum AA_AND_WATERS

Visit AminoAcids first and then visit Waters.

HETEROGENS

public static final ResidueEnum HETEROGENS

Visit only Heterogens.

WATERS

public static final ResidueEnum WATERS

Visit only Waters.

Method Detail

values

public static final ResidueEnum[] values()

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

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

Returns:

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

valueOf

public static ResidueEnum valueOf(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:

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

toString

public String toString()

Returns the Residue type as a String suitable for use in a menu: for example, "Amino Acids" rather then "AMINO_ACIDS".

Overrides:

toString in class Enum<ResidueEnum>

Returns:

The Residue type as a String.