From 398d0324b461e3a370b7b70a5506d78627dda525 Mon Sep 17 00:00:00 2001 From: mohammadbireybi Date: Wed, 18 Feb 2026 23:50:06 +0100 Subject: [PATCH 1/5] [Javadoc]: Add usage examples to `CharSet.contains` Javadoc --- src/main/java/org/apache/commons/lang3/CharSet.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java index a97a54d567e..0cabf904d0a 100644 --- a/src/main/java/org/apache/commons/lang3/CharSet.java +++ b/src/main/java/org/apache/commons/lang3/CharSet.java @@ -221,7 +221,14 @@ protected void add(final String str) { * Does the {@link CharSet} contain the specified * character {@code ch}. * - * @param ch the character to check for + *

Examples:

+ *
+     * CharSet.getInstance("a-c").contains('b') = true
+     * CharSet.getInstance("a-c").contains('d') = false
+     * CharSet.getInstance("^a-c").contains('d') = true
+     * 
+ * + * @param ch The character to check for. * @return {@code true} if the set contains the characters */ public boolean contains(final char ch) { From 5c1509d9450772a1e463784d88398e43e107baed Mon Sep 17 00:00:00 2001 From: mohammadbireybi Date: Thu, 19 Feb 2026 00:32:00 +0100 Subject: [PATCH 2/5] [Javadoc]: Fix minor punctuation in `CharSet.contains` Javadoc --- src/main/java/org/apache/commons/lang3/CharSet.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java index 0cabf904d0a..d725e5f8a61 100644 --- a/src/main/java/org/apache/commons/lang3/CharSet.java +++ b/src/main/java/org/apache/commons/lang3/CharSet.java @@ -228,7 +228,7 @@ protected void add(final String str) { * CharSet.getInstance("^a-c").contains('d') = true * * - * @param ch The character to check for. + * @param ch The character to check for * @return {@code true} if the set contains the characters */ public boolean contains(final char ch) { From 13f4f8ae67b1b933e72052af252f87940d916d02 Mon Sep 17 00:00:00 2001 From: mohammadbireybi Date: Thu, 19 Feb 2026 00:35:00 +0100 Subject: [PATCH 3/5] [Javadoc]: Standardize parameter description in `CharSet.contains` Javadoc - revert to original form --- src/main/java/org/apache/commons/lang3/CharSet.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java index d725e5f8a61..1c70b15f261 100644 --- a/src/main/java/org/apache/commons/lang3/CharSet.java +++ b/src/main/java/org/apache/commons/lang3/CharSet.java @@ -228,7 +228,7 @@ protected void add(final String str) { * CharSet.getInstance("^a-c").contains('d') = true * * - * @param ch The character to check for + * @param ch the character to check for * @return {@code true} if the set contains the characters */ public boolean contains(final char ch) { From dec11621181126e1bef9144d052496ba483a46ef Mon Sep 17 00:00:00 2001 From: mohammadbireybi Date: Fri, 20 Feb 2026 19:42:50 +0100 Subject: [PATCH 4/5] [Javadoc]: Expand and copy examples in `CharSet.contains` Javadoc for clarification from class level. --- src/main/java/org/apache/commons/lang3/CharSet.java | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java index 1c70b15f261..b4a826addb9 100644 --- a/src/main/java/org/apache/commons/lang3/CharSet.java +++ b/src/main/java/org/apache/commons/lang3/CharSet.java @@ -223,9 +223,13 @@ protected void add(final String str) { * *

Examples:

*
-     * CharSet.getInstance("a-c").contains('b') = true
-     * CharSet.getInstance("a-c").contains('d') = false
-     * CharSet.getInstance("^a-c").contains('d') = true
+     *     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
      * 
* * @param ch the character to check for From e232533346e82ee15cfc49259f935aa8f8159b93 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Sat, 21 Feb 2026 07:15:42 -0500 Subject: [PATCH 5/5] Clarify examples for negation character in CharSet Updated example description to clarify usage of negation character. --- src/main/java/org/apache/commons/lang3/CharSet.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/apache/commons/lang3/CharSet.java b/src/main/java/org/apache/commons/lang3/CharSet.java index b4a826addb9..89dc5fe631a 100644 --- a/src/main/java/org/apache/commons/lang3/CharSet.java +++ b/src/main/java/org/apache/commons/lang3/CharSet.java @@ -221,7 +221,7 @@ protected void add(final String str) { * Does the {@link CharSet} contain the specified * character {@code ch}. * - *

Examples:

+ *

Examples using the negation character:

*
      *     CharSet.getInstance("^a-c").contains('a') = false
      *     CharSet.getInstance("^a-c").contains('d') = true