Skip to content

[Javadoc] Add usage examples to CharSet.contains(char) #1605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
garydgregory merged 5 commits into from
Feb 21, 2026
+11 −0
Merged

[Javadoc] Add usage examples to CharSet.contains(char) #1605

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
398d032
[Javadoc]: Add usage examples to `CharSet.contains` Javadoc
Milanx22 Feb 18, 2026
5c1509d
[Javadoc]: Fix minor punctuation in `CharSet.contains` Javadoc
Milanx22 Feb 18, 2026
13f4f8a
[Javadoc]: Standardize parameter description in `CharSet.contains` Ja…
Milanx22 Feb 18, 2026
dec1162
[Javadoc]: Expand and copy examples in `CharSet.contains` Javadoc for…
Milanx22 Feb 20, 2026
e232533
Clarify examples for negation character in CharSet
garydgregory Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/main/java/org/apache/commons/lang3/CharSet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down