Skip to content

Fix two Javadoc errors in StringUtils #1763

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 2 commits into from
Jul 30, 2026
+9 −7
Merged

Fix two Javadoc errors in StringUtils #1763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b30155
Fix StringUtils.trimAsciiControl Javadoc
hunghhdev Jul 30, 2026
36e8996
Fix StringUtils.abbreviate Javadoc example for a single-character marker
hunghhdev Jul 30, 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
15 changes: 8 additions & 7 deletions src/main/java/org/apache/commons/lang3/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ public static String abbreviate(final String str, final String abbrevMarker, fin
* StringUtils.abbreviate("abcdefghijklmno", ",", 2, 10) = "abcdefghi,"
* StringUtils.abbreviate("abcdefghijklmno", "::", 4, 10) = "::efghij::"
* StringUtils.abbreviate("abcdefghijklmno", "...", 6, 10) = "...ghij..."
* StringUtils.abbreviate("abcdefghijklmno", "…", 6, 10) = "…ghij…"
* StringUtils.abbreviate("abcdefghijklmno", "…", 6, 10) = "…ghijklmno"
* StringUtils.abbreviate("abcdefghijklmno", "*", 9, 10) = "*ghijklmno"
* StringUtils.abbreviate("abcdefghijklmno", "'", 10, 10) = "'ghijklmno"
* StringUtils.abbreviate("abcdefghijklmno", "!", 12, 10) = "!ghijklmno"
Expand Down Expand Up @@ -8845,18 +8845,19 @@ public static String trim(final String str) {
}

/**
* Removes control characters (char <= 31) from both ends of this String, handling {@code null} by returning {@code null}.
* Removes {@link CharUtils#isAsciiControl(char) ASCII control characters} (char <= 31 or char == 127) from both ends of this String, handling
* {@code null} by returning {@code null}.
*
* <p>
* To trim your choice of characters, use the {@link #strip(String, String)} methods.
* </p>
*
* <pre>{@code
* StringUtils.trim(null) = null
* StringUtils.trim("") = ""
* StringUtils.trim("abc\u0000") = "abc"
* StringUtils.trim("abc") = "abc"
* StringUtils.trim(" abc ") = " abc "
* StringUtils.trimAsciiControl(null) = null
* StringUtils.trimAsciiControl("") = ""
* StringUtils.trimAsciiControl("abc\u0000") = "abc"
* StringUtils.trimAsciiControl("abc") = "abc"
* StringUtils.trimAsciiControl(" abc ") = " abc "
* }</pre>
*
* @param str The String to be trimmed, may be null.
Expand Down
1 change: 1 addition & 0 deletions src/test/java/org/apache/commons/lang3/StringUtilsAbbreviateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ void testAbbreviate_StringStringIntInt() {
assertAbbreviateWithAbbrevMarkerAndOffset("abcdef____", "____", 5, 10);
assertAbbreviateWithAbbrevMarkerAndOffset("==fghijk==", "==", 5, 10);
assertAbbreviateWithAbbrevMarkerAndOffset("___ghij___", "___", 6, 10);
assertAbbreviateWithAbbrevMarkerAndOffset("…ghijklmno", "…", 6, 10);
assertAbbreviateWithAbbrevMarkerAndOffset("/ghijklmno", "/", 7, 10);
assertAbbreviateWithAbbrevMarkerAndOffset("/ghijklmno", "/", 8, 10);
assertAbbreviateWithAbbrevMarkerAndOffset("/ghijklmno", "/", 9, 10);
Expand Down
Loading