Comparable
| java.lang.Comparable<T> |
 Known Indirect Subclasses
Boolean,
CapitalizeMode,
CookiePolicy,
ElementType,
Enum<E extends Enum<E>>,
RetentionPolicy,
TextMode
|
Class Overview
This interface should be implemented by all classes that wish to define a
natural order of their instances. sort(List
and java.util.Arrays#sort can then be used to automatically sort
lists of classes that implement this interface.
The order rule must be both transitive (if x.compareTo(y) < 0 and
y.compareTo(z) < 0, then x.compareTo(z) < 0 must hold) and
invertible (the sign of the result of x.compareTo(y) must be equal to the
negation of the sign of the result of y.compareTo(x) for all combinations of
x and y).
In addition, it is recommended (but not required) that if and only if the
result of x.compareTo(y) is zero, then the result of x.equals(y) should be
true.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
compareTo(T another)
Compares this object to the specified object to determine their relative
order.
| ||||||||||
Public Methods
public abstract int compareTo (T another)
Compares this object to the specified object to determine their relative order.
Parameters
| another | the object to compare to this instance. |
|---|
Returns
- a negative integer if this instance is less than
another; a positive integer if this instance is greater thananother; 0 if this instance has the same order asanother.
Throws
| ClassCastException | if another cannot be converted into something comparable
to this instance.
|
|---|