org.proteinshader.structure.visitor.enums
Enum ResidueMode

java.lang.Object
  java.lang.Enum<ResidueMode>
      org.proteinshader.structure.visitor.enums.ResidueMode

All Implemented Interfaces:

Serializable, Comparable<ResidueMode>

public enum ResidueMode
extends Enum<ResidueMode>

Provides an enumeration that can be used to control the traversal pattern of a Visitor object.

Enum Constant Summary

AA_AND_HETEROGENS
Visit AminoAcids first and then visit Heterogens.

AA_AND_WATERS
Visit AminoAcids first and then visit Waters.

ALL
Visit all Residue types.

AMINO_ACIDS
Visit only AminoAcids.

HET_AND_WATERS
Visit Heterogens first and then Waters.

HETEROGENS
Visit only Heterogens.

NONE
Visit no Residues.

WATERS
Visit only Waters.

Method Summary

static ResidueMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResidueMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

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

Enum Constant Detail

ALL

public static final ResidueMode ALL

Visit all Residue types.

AMINO_ACIDS

public static final ResidueMode AMINO_ACIDS

Visit only AminoAcids.

AA_AND_WATERS

public static final ResidueMode AA_AND_WATERS

Visit AminoAcids first and then visit Waters.

AA_AND_HETEROGENS

public static final ResidueMode AA_AND_HETEROGENS

Visit AminoAcids first and then visit Heterogens.

HETEROGENS

public static final ResidueMode HETEROGENS

Visit only Heterogens.

WATERS

public static final ResidueMode WATERS

Visit only Waters.

HET_AND_WATERS

public static final ResidueMode HET_AND_WATERS

Visit Heterogens first and then Waters.

NONE

public static final ResidueMode NONE

Visit no Residues.

Method Detail

values

public static final ResidueMode[] 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(ResidueMode c : ResidueMode.values())
        System.out.println(c);

Returns:

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

valueOf

public static ResidueMode 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