|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.collections.comparators.ComparableComparator
public class ComparableComparator
A Comparator
that compares
Comparable
objects.
ClassCastException
if
either of the arguments to compare
were null
, not Comparable
,
or for which compareTo
gave
inconsistent results. This is no longer the case. See
compare
for details.
Collections.reverseOrder()
,
Serialized FormConstructor Summary | |
---|---|
ComparableComparator()
Constructor whose use should be avoided. |
Method Summary | |
---|---|
int |
compare(Comparable obj1,
Comparable obj2)
Compare the two Comparable arguments. |
boolean |
equals(Object object)
Returns true iff that Object is
is a Comparator whose ordering is
known to be equivalent to mine. |
static ComparableComparator |
getInstance()
Gets the singleton instance of a ComparableComparator. |
int |
hashCode()
Implement a hash code for this comparator that is consistent with equals . |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ComparableComparator()
getInstance()
method whenever possible.
Method Detail |
---|
public static ComparableComparator getInstance()
public int compare(Comparable obj1, Comparable obj2)
Comparable
arguments.
This method is equivalent to:
((Comparable)obj1).compareTo(obj2)
compare
in interface Comparator<Comparable>
obj1
- the first object to compareobj2
- the second object to compare
NullPointerException
- when obj1 is null
,
or when ((Comparable)obj1).compareTo(obj2)
does
ClassCastException
- when obj1 is not a Comparable
,
or when ((Comparable)obj1).compareTo(obj2)
doespublic int hashCode()
equals
.
hashCode
in class Object
public boolean equals(Object object)
true
iff that Object is
is a Comparator
whose ordering is
known to be equivalent to mine.
This implementation returns true
iff object.getClass()
equals this.getClass()
.
Subclasses may want to override this behavior to remain consistent
with the Comparator.equals(Object)
contract.
equals
in interface Comparator<Comparable>
equals
in class Object
object
- the object to compare with
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |