Package pl.poznan.put.rna

Enum NucleotideTorsionAngle

java.lang.Object

java.lang.Enum<NucleotideTorsionAngle>

pl.poznan.put.rna.NucleotideTorsionAngle

All Implemented Interfaces:

Serializable, Comparable<NucleotideTorsionAngle>, DisplayableExportable, MasterTorsionAngleType

public enum NucleotideTorsionAngle
extends Enum<NucleotideTorsionAngle>
implements MasterTorsionAngleType

A torsion angle defined in a nucleotide.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALPHA
BETA
CHI
DELTA
EPSILON
ETA
ETA_PRIM
GAMMA
NU0
NU1
NU2
NU3
NU4
PSEUDOPHASE_PUCKER
THETA
THETA_PRIM
ZETA

Method Summary

Modifier and Type	Method	Description
List<TorsionAngleType>	angleTypes()
String	exportName()
String	longDisplayName()
Range	range(Angle angle)	Finds a matching range for the given angle value.
String	shortDisplayName()
static NucleotideTorsionAngle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NucleotideTorsionAngle[]	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

ALPHA

public static final NucleotideTorsionAngle ALPHA

BETA

public static final NucleotideTorsionAngle BETA

GAMMA

public static final NucleotideTorsionAngle GAMMA

DELTA

public static final NucleotideTorsionAngle DELTA

EPSILON

public static final NucleotideTorsionAngle EPSILON

ZETA

public static final NucleotideTorsionAngle ZETA

NU0

public static final NucleotideTorsionAngle NU0

NU1

public static final NucleotideTorsionAngle NU1

NU2

public static final NucleotideTorsionAngle NU2

NU3

public static final NucleotideTorsionAngle NU3

NU4

public static final NucleotideTorsionAngle NU4

ETA

public static final NucleotideTorsionAngle ETA

THETA

public static final NucleotideTorsionAngle THETA

ETA_PRIM

public static final NucleotideTorsionAngle ETA_PRIM

THETA_PRIM

public static final NucleotideTorsionAngle THETA_PRIM

CHI

public static final NucleotideTorsionAngle CHI

PSEUDOPHASE_PUCKER

public static final NucleotideTorsionAngle PSEUDOPHASE_PUCKER

Method Detail

values

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

Returns:

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

valueOf

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

NullPointerException - if the argument is null

angleTypes

public List<TorsionAngleType> angleTypes()

Specified by:

angleTypes in interface MasterTorsionAngleType

Returns:

The list of basic angle types this type consists of.

range

public Range range(Angle angle)

Description copied from interface: MasterTorsionAngleType

Finds a matching range for the given angle value.

Specified by:

range in interface MasterTorsionAngleType

Parameters:

angle - The angle value to find the range for.

Returns:

An instance of Range which incorporates this angle.

shortDisplayName

public String shortDisplayName()

Specified by:

shortDisplayName in interface DisplayableExportable

Returns:

A short name to be shown in UI summary.

longDisplayName

public String longDisplayName()

Specified by:

longDisplayName in interface DisplayableExportable

Returns:

A long name to be shown in UI, may contain Unicode.

exportName

public String exportName()

Specified by:

exportName in interface DisplayableExportable

Returns:

A name to be used during export to output file, should be ASCII only.