public final class GenomicAssemblyLevel extends Object implements Serializable, Comparable<GenomicAssemblyLevel>
Modifier and Type | Field and Description |
---|---|
static GenomicAssemblyLevel |
CHROMOSOME |
static GenomicAssemblyLevel |
COMPLETE_GENOME |
static GenomicAssemblyLevel |
CONTIG |
static GenomicAssemblyLevel |
SCAFFOLD |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(GenomicAssemblyLevel inObj2)
Compares this object with the specified object for order.
|
boolean |
equals(Object inObj) |
int |
hashCode() |
String |
name() |
String |
toString() |
static GenomicAssemblyLevel |
valueOf(String inValue) |
static GenomicAssemblyLevel[] |
values() |
public static final GenomicAssemblyLevel COMPLETE_GENOME
public static final GenomicAssemblyLevel CHROMOSOME
public static final GenomicAssemblyLevel SCAFFOLD
public static final GenomicAssemblyLevel CONTIG
public static GenomicAssemblyLevel valueOf(String inValue)
public static GenomicAssemblyLevel[] values()
public int compareTo(GenomicAssemblyLevel inObj2)
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.
compareTo
in interface Comparable<GenomicAssemblyLevel>
inObj2
- the object to be compared.ClassCastException
- if the specified object's type prevents it
from being compared to this object.