Package pl.poznan.put.rna

Enum ChiRange

java.lang.Object

java.lang.Enum<ChiRange>

pl.poznan.put.rna.ChiRange

All Implemented Interfaces:

Serializable, Comparable<ChiRange>, Range

public enum ChiRange
extends Enum<ChiRange>
implements Range

A range description for chi torsion angle type as defined in Saenger's "Principles...".

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANTI
HIGH_ANTI
INVALID
SYN

Method Summary

Modifier and Type	Method	Description
Angle	begin()
RangeDifference	compare(Range other)	Compares with another range object.
String	displayName()
Angle	end()
static RangeProvider	getProvider()
static ChiRange	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ChiRange[]	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

HIGH_ANTI

public static final ChiRange HIGH_ANTI

SYN

public static final ChiRange SYN

ANTI

public static final ChiRange ANTI

INVALID

public static final ChiRange INVALID

Method Detail

values

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

Returns:

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

valueOf

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

getProvider

public static RangeProvider getProvider()

displayName

public String displayName()

Specified by:

displayName in interface Range

Returns:

The name of this torsion angle range.

begin

public Angle begin()

Specified by:

begin in interface Range

Returns:

The beginning value of the range.

end

public Angle end()

Specified by:

end in interface Range

Returns:

The ending value of the range.

compare

public RangeDifference compare(Range other)

Description copied from interface: Range

Compares with another range object.

Specified by:

compare in interface Range

Parameters:

other - The other range object.

Returns:

An enumerated value showing how much does these two ranges really differ.