Adding note on requiring Comparator for non-Comparable. LANG-620

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@946897 13f79535-47bb-0310-9956-ffa450edef68
2010-05-21 06:29:43 +00:00 · 2010-05-21 06:29:43 +00:00 · 85d065031b
parent 9a9da72d00
commit 85d065031b
1 changed files with 2 additions and 0 deletions
--- a/src/main/java/org/apache/commons/lang3/Range.java
+++ b/src/main/java/org/apache/commons/lang3/Range.java
@ -21,6 +21,8 @@

 /**
 * <p><code>Range</code> represents an immutable range of numbers of the same type.</p>
+ * <p>The objects need to either be implementations of <code>java.lang.Comparable</code>
+ * or you need to supply a <code>java.util.Comparator</code>. </p>
 * 
 * <p>#ThreadSafe#</p>
 * @author Apache Software Foundation