org.proteinshader.structure.visitor.enums
Enum RegionMode

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

All Implemented Interfaces:

Serializable, Comparable<RegionMode>

public enum RegionMode
extends Enum<RegionMode>

Provides an enumeration that can be used to control whether a Visitor object traverses Regions (Helices or BetaStrands).

Enum Constant Summary

ALL_REGIONS
Visit Helices, BetaStrands, and all Residues of a Chain.

BETA_STRANDS
Visit BetaStrands only.

HELICES
Visit Helices only.

LOOPS
Visit Loops only.

NO_REGIONS
Visit Residues of a Chain, but no Regions.

Method Summary

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

NO_REGIONS

public static final RegionMode NO_REGIONS

Visit Residues of a Chain, but no Regions.

LOOPS

public static final RegionMode LOOPS

Visit Loops only.

HELICES

public static final RegionMode HELICES

Visit Helices only.

BETA_STRANDS

public static final RegionMode BETA_STRANDS

Visit BetaStrands only.

ALL_REGIONS

public static final RegionMode ALL_REGIONS

Visit Helices, BetaStrands, and all Residues of a Chain. This mode is mainly intended for a writer that needs to visit everything.

Method Detail

values

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

Returns:

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

valueOf

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