Author: bayard
Date: Thu Jul 7 03:46:18 2011
New Revision: 1143642
URL: http://svn.apache.org/viewvc?rev=1143642&view=rev
Log:
Updating javadoc to mention all three options
Modified:
commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
Modified: commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
URL: http://svn.apache.org/viewvc/commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java?rev=1143642&r1=1143641&r2=1143642&view=diff
==============================================================================
--- commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
(original)
+++ commons/proper/lang/trunk/src/main/java/org/apache/commons/lang3/text/translate/NumericEntityUnescaper.java
Thu Jul 7 03:46:18 2011
@@ -40,12 +40,16 @@ public class NumericEntityUnescaper exte
/**
* Create a UnicodeUnescaper.
*
- * The constructor takes a list of options, only one of which is currently
- * available (whether to allow the semi-colon on the end of a numeric entity to
- * be optional.
+ * The constructor takes a list of options, only one type of which is currently
+ * available (whether to allow, error or ignore the semi-colon on the end of a
+ * numeric entity to being missing).
*
* For example, to support numeric entities without a ';':
* new NumericEntityUnescaper(NumericEntityUnescaper.OPTION.semiColonOptional)
+ * and to throw a RuntimeException when they're missing:
+ * new NumericEntityUnescaper(NumericEntityUnescaper.OPTION.errorIfNoSemiColon)
+ *
+ * Note that the default behaviour is to ignore them.
*
* @param options to apply to this unescaper
*/
|