Skip to content

Clarify truncate method Javadoc #1536

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

Open
Akshat19Upadhyay wants to merge 4 commits into
base: master
Choose a base branch
from
+3 −3
Open

Clarify truncate method Javadoc #1536

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ce2b99
Clarify truncate method Javadoc
Akshat19Upadhyay Dec 19, 2025
2d30299
Remove unnecessary line break in Javadoc comments
garydgregory Dec 19, 2025
77b8551
Fix truncate Javadoc wording and formatting
Akshat19Upadhyay Dec 20, 2025
2c84a29
Fix inaccurate wording in truncate Javadoc
Akshat19Upadhyay Dec 20, 2025
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
6 changes: 3 additions & 3 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 @@ -8819,8 +8819,8 @@ public static String truncate(final String str, final int maxWidth) {
* Specifically:
* </p>
* <ul>
* <li>If {@code str} is less than {@code maxWidth} characters long, return it.</li>
* <li>Else truncate it to {@code substring(str, offset, maxWidth)}.</li>
* <li>If {@code str} is shorter than {@code maxWidth}, returns a String containing the same characters.</li>
* <li>Else truncate it to a substring starting at {@code offset} with a maximum length of {@code maxWidth}.</li
* <li>If {@code maxWidth} is less than {@code 0}, throw an {@link IllegalArgumentException}.</li>
* <li>If {@code offset} is less than {@code 0}, throw an {@link IllegalArgumentException}.</li>
* <li>In no case will it return a String of length greater than {@code maxWidth}.</li>
Expand Down Expand Up @@ -8861,7 +8861,7 @@ public static String truncate(final String str, final int maxWidth) {
*
* @param str the String to truncate, may be null.
* @param offset left edge of source String.
* @param maxWidth maximum length of result String, must be positive.
* @param maxWidth maximum length of result String, must be non-negative.
* @return truncated String, {@code null} if null String input.
* @throws IllegalArgumentException If {@code offset} or {@code maxWidth} is less than {@code 0}.
* @since 3.5
Expand Down