org.proteinshader.structure.enums
Enum HelixEnum

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

All Implemented Interfaces:

Serializable, Comparable<HelixEnum>

public enum HelixEnum
extends Enum<HelixEnum>

Provides an enumeration of the helix types specified in the Protein Data Bank .

Enum Constant Summary

LH_ALPHA
Left-handed alpha-helix: PDB class number 6

LH_GAMMA
Left-handed gamma-helix: PDB class number 8

LH_OMEGA
Left-handed omega-helix: PDB class number 7

POLYPROPYLINE
Polypropyline helix: PDB class number 10

RH_310
Right-handed 310 helix: PDB class number 5

RH_ALPHA
Right-handed alpha-helix: PDB class number 1

RH_GAMMA
Right-handed gamma-helix: PDB class number 4

RH_OMEGA
Right-handed omega-helix: PDB class number 2

RH_PI
Right-handed PI helix: PDB class number 3

TWO_SEVEN_RIBBON
2-7 ribbon/helix: PDB class number 9

Method Summary

int	getPDBClassNo() Returns the PDB classification number.
static HelixEnum	valueOf(int pdbClassNo) Returns the HelixEnum corresponding to the PDB classification number given as an argument.
static HelixEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static HelixEnum[]	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

RH_ALPHA

public static final HelixEnum RH_ALPHA

Right-handed alpha-helix: PDB class number 1

RH_OMEGA

public static final HelixEnum RH_OMEGA

Right-handed omega-helix: PDB class number 2

RH_PI

public static final HelixEnum RH_PI

Right-handed PI helix: PDB class number 3

RH_GAMMA

public static final HelixEnum RH_GAMMA

Right-handed gamma-helix: PDB class number 4

RH_310

public static final HelixEnum RH_310

Right-handed 310 helix: PDB class number 5

LH_ALPHA

public static final HelixEnum LH_ALPHA

Left-handed alpha-helix: PDB class number 6

LH_OMEGA

public static final HelixEnum LH_OMEGA

Left-handed omega-helix: PDB class number 7

LH_GAMMA

public static final HelixEnum LH_GAMMA

Left-handed gamma-helix: PDB class number 8

TWO_SEVEN_RIBBON

public static final HelixEnum TWO_SEVEN_RIBBON

2-7 ribbon/helix: PDB class number 9

POLYPROPYLINE

public static final HelixEnum POLYPROPYLINE

Polypropyline helix: PDB class number 10

Method Detail

values

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

Returns:

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

valueOf

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

getPDBClassNo

public int getPDBClassNo()

Returns the PDB classification number.

Returns:

The classification number as an int.

valueOf

public static HelixEnum valueOf(int pdbClassNo)

Returns the HelixEnum corresponding to the PDB classification number given as an argument.

Returns:

The HelixEnum for the pdbClassNo.

Throws:

IllegalArgumentException - if no HelixEnum matches the pdbClassNo.