From c095f1aac131a175e8dbca8e670b9179bebffec8 Mon Sep 17 00:00:00 2001 From: Morgan James Delagrange Date: Thu, 28 Feb 2002 18:06:39 +0000 Subject: [PATCH] javadoc git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@130616 13f79535-47bb-0310-9956-ffa450edef68 --- .../collections/comparators/ComparableComparator.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/java/org/apache/commons/collections/comparators/ComparableComparator.java b/src/java/org/apache/commons/collections/comparators/ComparableComparator.java index 67322e52a..a851f32be 100644 --- a/src/java/org/apache/commons/collections/comparators/ComparableComparator.java +++ b/src/java/org/apache/commons/collections/comparators/ComparableComparator.java @@ -63,10 +63,12 @@ import java.lang.Comparable; * 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 bayard@generationjava.com - * @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 {