Adding a javadoc note regarding LANG-882

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/lang/trunk@1470384 13f79535-47bb-0310-9956-ffa450edef68
2013-04-22 04:18:24 +00:00 · 2013-04-22 04:18:24 +00:00 · cd91a4f2cd
parent 9d73fe09ce
commit cd91a4f2cd
1 changed files with 4 additions and 0 deletions
--- a/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java
+++ b/src/main/java/org/apache/commons/lang3/text/translate/LookupTranslator.java
@ -22,6 +22,10 @@ import java.util.HashMap;

 /**
 * Translates a value using a lookup table.
+ *
+ * NOTE: This class is broken for any CharSequence implementation that does not define 
+ *       equals(Object) and hashCode() methods as the class uses the CharSequence as 
+ *       the key to a HashMap. See http://issues.apache.org/jira/browse/LANG-882.
 * 
 * @since 3.0
 * @version $Id$