com.hfg.bio.seq.genomic.assembly

Class GenomicRefSeqCategory

java.lang.Object

com.hfg.bio.seq.genomic.assembly.GenomicRefSeqCategory

All Implemented Interfaces:

Serializable, Comparable<GenomicRefSeqCategory>

public final class GenomicRefSeqCategory
extends Object
implements Serializable, Comparable<GenomicRefSeqCategory>

Enumeration of genomic RefSeq categories.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static GenomicRefSeqCategory	NA
static GenomicRefSeqCategory	REFERENCE_GENOME
static GenomicRefSeqCategory	REPRESENTATIVE_GENOME

Method Summary

Modifier and Type	Method and Description
int	compareTo(GenomicRefSeqCategory inObj2) Compares this object with the specified object for order.
boolean	equals(Object inObj)
int	hashCode()
String	name()
String	toString()
static GenomicRefSeqCategory	valueOf(String inValue)
static GenomicRefSeqCategory[]	values()

Methods inherited from class java.lang.Object

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

Field Detail

REFERENCE_GENOME

public static final GenomicRefSeqCategory REFERENCE_GENOME

REPRESENTATIVE_GENOME

public static final GenomicRefSeqCategory REPRESENTATIVE_GENOME

NA

public static final GenomicRefSeqCategory NA

Method Detail

toString

public final String toString()

Overrides:

toString in class Object

valueOf

public static GenomicRefSeqCategory valueOf(String inValue)

values

public static GenomicRefSeqCategory[] values()

name

public final String name()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object inObj)

Overrides:

equals in class Object

compareTo

public int compareTo(GenomicRefSeqCategory inObj2)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that sgn(x.compareTo(z)) == sgn(y.compareTo(z)), for all z.

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero, or positive, respectively.

Specified by:

compareTo in interface Comparable<GenomicRefSeqCategory>

Parameters:

inObj2 - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

ClassCastException - if the specified object's type prevents it from being compared to this object.