Skip to content

Corrected documentation for StringUtils.abbreviate() #343

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
phymod0 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Corrected documentation for StringUtils.abbreviate() #343

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd33aa4
Corrected documentation for StringUtils.abbreviate()
phymod0 Aug 20, 2025
b0c3af4
Merge pull request #1 from phymod0/phymod0-update-abbreviate-document…
phymod0 Aug 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
2 changes: 1 addition & 1 deletion src/main/java/org/apache/maven/shared/utils/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1756,7 +1756,7 @@ private static void reverseArray(@Nonnull String... array) {
/**
* <p>Turn "Now is the time for all good men" into "Now is the time for..."</p>
* <p>Specifically:</p>
* <p>If str is less than max characters long, return it.
* <p>If str is no greater than max characters long, return it.
Copy link
Contributor

@elharo elharo Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about "less than or equal to"?

* Else abbreviate it to (substring(str, 0, max-3) + "...").
* If maxWidth is less than 3, throw an IllegalArgumentException.
* In no case will it return a string of length greater than maxWidth.</p>
Expand Down
Loading