Class ReverseComparator
- java.lang.Object
-
- org.apache.commons.collections.comparators.ReverseComparator
-
- All Implemented Interfaces:
Serializable
,Comparator
public class ReverseComparator extends Object implements Comparator, Serializable
Reverses the order of another comparator by reversing the arguments to itscompare
method.- Since:
- Commons Collections 2.0
- Version:
- $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
- Author:
- Henri Yandell, Michael A. Smith
- See Also:
Collections.reverseOrder()
, Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ReverseComparator()
Creates a comparator that compares objects based on the inverse of their natural ordering.ReverseComparator(Comparator comparator)
Creates a comparator that inverts the comparison of the given comparator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compare(Object obj1, Object obj2)
Compares two objects in reverse order.boolean
equals(Object object)
Returnstrue
iff that Object is is aComparator
whose ordering is known to be equivalent to mine.int
hashCode()
Implement a hash code for this comparator that is consistent withequals
.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.util.Comparator
reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong
-
-
-
-
Constructor Detail
-
ReverseComparator
public ReverseComparator()
Creates a comparator that compares objects based on the inverse of their natural ordering. Using this Constructor will create a ReverseComparator that is functionally identical to the Comparator returned by java.util.Collections.reverseOrder().- See Also:
Collections.reverseOrder()
-
ReverseComparator
public ReverseComparator(Comparator comparator)
Creates a comparator that inverts the comparison of the given comparator. If you pass innull
, the ReverseComparator defaults to reversing the natural order, as perCollections.reverseOrder()
.- Parameters:
comparator
- Comparator to reverse
-
-
Method Detail
-
compare
public int compare(Object obj1, Object obj2)
Compares two objects in reverse order.- Specified by:
compare
in interfaceComparator
- Parameters:
obj1
- the first object to compareobj2
- the second object to compare- Returns:
- negative if obj1 is less, positive if greater, zero if equal
-
hashCode
public int hashCode()
Implement a hash code for this comparator that is consistent withequals
.
-
equals
public boolean equals(Object object)
Returnstrue
iff that Object is is aComparator
whose ordering is known to be equivalent to mine.This implementation returns
true
iffobject.
equalsgetClass()
this.getClass()
, and the underlying comparators are equal. Subclasses may want to override this behavior to remain consistent with theequals
contract.- Specified by:
equals
in interfaceComparator
- Overrides:
equals
in classObject
- Parameters:
object
- the object to compare to- Returns:
- true if equal
- Since:
- Commons Collections 3.0
-
-