public class

ReverseComparator

extends Object
implements Serializable Comparator<T>
java.lang.Object
   ↳ org.apache.commons.collections.comparators.ReverseComparator

Class Overview

Reverses the order of another comparator by reversing the arguments to its compare method.

See Also

Summary

Public Constructors
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.
Public Methods
int compare(Object obj1, Object obj2)
Compares two objects in reverse order.
boolean equals(Object object)
Returns true iff that Object is is a Comparator whose ordering is known to be equivalent to mine.
int hashCode()
Implement a hash code for this comparator that is consistent with equals.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.util.Comparator

Public Constructors

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

public ReverseComparator (Comparator comparator)

Creates a comparator that inverts the comparison of the given comparator. If you pass in null, the ReverseComparator defaults to reversing the natural order, as per reverseOrder().

Parameters
comparator Comparator to reverse

Public Methods

public int compare (Object obj1, Object obj2)

Compares two objects in reverse order.

Parameters
obj1 the first object to compare
obj2 the second object to compare
Returns
  • negative if obj1 is less, positive if greater, zero if equal

public boolean equals (Object object)

Returns 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(), and the underlying comparators are equal. Subclasses may want to override this behavior to remain consistent with the equals contract.

Parameters
object the object to compare to
Returns
  • true if equal

public int hashCode ()

Implement a hash code for this comparator that is consistent with equals.

Returns
  • a suitable hash code