morgand 02/02/28 10:06:39
Modified: collections/src/java/org/apache/commons/collections/comparators
ComparableComparator.java
Log:
javadoc
Revision Changes Path
1.2 +4 -2
jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/ComparableComparator.java
Index: ComparableComparator.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/comparators/ComparableComparator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ComparableComparator.java 26 Feb 2002 22:42:31 -0000 1.1
+++ ComparableComparator.java 28 Feb 2002 18:06:39 -0000 1.2
@@ -63,10 +63,12 @@
* Comparable, or if they are null.
* Throws ClassCastException if the compareTo of both
* objects do not provide an inverse result of each other
- * as per the Comparable javadoc.
+ * as per the Comparable javadoc. This Comparator is useful, for example,
+ * for enforcing the natural order in custom implementations
+ * of SortedSet and SortedMap.
*
* @author [EMAIL PROTECTED]
- * @version $Id: ComparableComparator.java,v 1.1 2002/02/26 22:42:31 morgand Exp $
+ * @version $Id: ComparableComparator.java,v 1.2 2002/02/28 18:06:39 morgand Exp $
*/
public class ComparableComparator implements Comparator {
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
