This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-lang.git
The following commit(s) were added to refs/heads/master by this push:
new 2eca27e38 [Javadoc]: Add usage examples to `CharSet.contains` Javadoc
(#1605)
2eca27e38 is described below
commit 2eca27e38219fadb4b685024d6065680e1f71000
Author: Mohammad Bireybi <[email protected]>
AuthorDate: Sat Feb 21 13:15:50 2026 +0100
[Javadoc]: Add usage examples to `CharSet.contains` Javadoc (#1605)
* [Javadoc]: Add usage examples to `CharSet.contains` Javadoc
* [Javadoc]: Fix minor punctuation in `CharSet.contains` Javadoc
* [Javadoc]: Standardize parameter description in `CharSet.contains`
Javadoc - revert to original form
* [Javadoc]: Expand and copy examples in `CharSet.contains` Javadoc for
clarification from class level.
* Clarify examples for negation character in CharSet
Updated example description to clarify usage of negation character.
---------
Co-authored-by: Gary Gregory <[email protected]>
---
src/main/java/org/apache/commons/lang3/CharSet.java | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java
b/src/main/java/org/apache/commons/lang3/CharSet.java
index a97a54d56..89dc5fe63 100644
--- a/src/main/java/org/apache/commons/lang3/CharSet.java
+++ b/src/main/java/org/apache/commons/lang3/CharSet.java
@@ -221,6 +221,17 @@ protected void add(final String str) {
* Does the {@link CharSet} contain the specified
* character {@code ch}.
*
+ * <p>Examples using the negation character:</p>
+ * <pre>
+ * CharSet.getInstance("^a-c").contains('a') = false
+ * CharSet.getInstance("^a-c").contains('d') = true
+ * CharSet.getInstance("^^a-c").contains('a') = true // (only '^' is
negated)
+ * CharSet.getInstance("^^a-c").contains('^') = false
+ * CharSet.getInstance("^a-cd-f").contains('d') = true
+ * CharSet.getInstance("a-c^").contains('^') = true
+ * CharSet.getInstance("^", "a-c").contains('^') = true
+ * </pre>
+ *
* @param ch the character to check for
* @return {@code true} if the set contains the characters
*/
