morgand 02/03/20 09:09:16
Modified: collections/src/java/org/apache/commons/collections/comparators
ReverseComparator.java
Log:
javadocs
Revision Changes Path
1.7 +14 -5
jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/ReverseComparator.java
Index: ReverseComparator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/ReverseComparator.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- ReverseComparator.java 20 Mar 2002 00:25:37 -0000 1.6
+++ ReverseComparator.java 20 Mar 2002 17:09:16 -0000 1.7
@@ -59,10 +59,10 @@
/**
* Reverses the order of another comparator.
- *
+ *
* @author [EMAIL PROTECTED]
* @author <a href="mailto:[EMAIL PROTECTED]";>Michael A. Smith</a>
- * @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 @@
/**
* 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.<b>reverseOrder()</b>.
+ *
+ * @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.<b>reverseOrder()</b>.
+ *
+ * @param comparator Comparator to reverse
*/
public ReverseComparator(Comparator comparator) {
if(comparator != null) {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
