Duncan Jones created LANG-1069:
----------------------------------
Summary: CharSet.getInstance documentation does not clearly
explain how to include negation character in set
Key: LANG-1069
URL: https://issues.apache.org/jira/browse/LANG-1069
Project: Commons Lang
Issue Type: Bug
Components: lang.*
Affects Versions: 3.3.2
Reporter: Duncan Jones
Priority: Minor
Fix For: Patch Needed
As discussed in [this Stack Overflow
question|http://stackoverflow.com/questions/27070515/how-can-i-include-the-caret-character-in-an-apache-commons-charset],
the documentation for {{CharSet.getInstance()}} don't explain clearly how to
include the negation character ({{^}}) as a literal character.
The two solutions suggested in the SO question are:
{code:java}
// Add the '^' on its own
CharSet.getInstance("^", "otherlettershere");
// Add the '^' as the last character
CharSet.getInstance("otherlettershere^")
{code}
If those are the best options, we should add a line to the Javadoc to indicate
this. If there is a better way, clearly that should be documented instead.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
