diff --git a/src/java/org/apache/commons/collections/comparators/ReverseComparator.java b/src/java/org/apache/commons/collections/comparators/ReverseComparator.java index 5db5ac268..a02a106ba 100644 --- a/src/java/org/apache/commons/collections/comparators/ReverseComparator.java +++ b/src/java/org/apache/commons/collections/comparators/ReverseComparator.java @@ -59,10 +59,10 @@ import java.util.Comparator; /** * Reverses the order of another comparator. - * + * * @author bayard@generationjava.com * @author Michael A. Smith - * @version $Id: ReverseComparator.java,v 1.6 2002/03/20 00:25:37 mas Exp $ + * @version $Id: ReverseComparator.java,v 1.7 2002/03/20 17:09:16 morgand Exp $ */ public class ReverseComparator implements Comparator,Serializable { @@ -70,15 +70,24 @@ public class ReverseComparator implements Comparator,Serializable { /** * Creates a comparator that compares objects based on the inverse of their - * natural ordering. + * natural ordering. Using this Constructor will create a ReverseComparator + * that is functionaly identical to the Comparator returned by + * java.util.Collections.reverseOrder(). + * + * @see java.util.Collections#reverseOrder() */ public ReverseComparator() { this(null); } /** - * Creates a reverse comparator that inverts the comparison - * of the passed in comparator. + * Creates a reverse comparator that inverts the comparison + * of the passed in comparator. If you pass in a null, + * the ReverseComparator defaults to reversing the + * natural order, as per + * java.util.Collections.reverseOrder(). + * + * @param comparator Comparator to reverse */ public ReverseComparator(Comparator comparator) { if(comparator != null) {