Skip to content

[LANG-1423] Javadoc: Include wrapping operations in StringUtils overview - #1850

Merged
garydgregory merged 2 commits into
apache:masterfrom
rys888:LANG-1423-string-utils-wrap-javadoc
Nov 1, 2026
Merged

garydgregory merged 2 commits into
apache:masterfrom
rys888:LANG-1423-string-utils-wrap-javadoc

Conversation

@rys888

@rys888 rys888 commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Fixes LANG-1423.

The class-level StringUtils overview lists the available operations but omits wrap, wrapIfMissing, and unwrap. Add a short entry for each, distinguishing unconditional wrapping, adding only missing wrapping content, and removing matching content from both ends.

This changes only Javadoc. No runtime code, imports, or method signatures change.

Validation (JDK 21, Maven 3.9.16):

  • Full default Maven goals passed: 92,172 tests, 0 failures, 0 errors, 18 skipped; RAT, Checkstyle, japicmp, SpotBugs, PMD, and Javadoc completed.
  • Command: mvn -B -ntp -s ../commons-lang-LANG-1423-validation/maven-settings.xml. The temporary settings file points the local mirror at Maven Central; no project configuration is changed or checks skipped.
  • Confirmed the generated StringUtils HTML contains the three overview entries.
  • Existing wrap/unwrap tests cover both char and String overloads. No additional tests are needed for this documentation-only change.

Checklist:

  • Read the contribution guidelines.
  • Read the ASF Generative Tooling Guidance.
  • AI assistance: OpenAI Codex helped inspect the issue and existing methods, draft the documentation, and run validation. This is an AI-assisted contribution.
  • Run a successful build using the default Maven goals.
  • Behavioral tests: not applicable; no runtime behavior changes. Existing tests pass.
  • Describe what changes and why.
  • Use a meaningful commit subject and body, including an Assisted-By trailer.

Review follow-up (2026-11-01): Removed the changes.xml entry as requested. The follow-up passed the documented non-test checks on JDK 21: mvn -B -ntp -DskipTests -DskipITs -s ../commons-lang-LANG-1423-validation/maven-settings.xml. Tests were skipped in this follow-up run; the full test results above describe the original submission.

Document wrap, wrapIfMissing, and unwrap in the class-level operation list so readers can discover the existing methods and distinguish their purposes.

Assisted-By: OpenAI Codex
Comment thread src/changes/changes.xml Outdated
<action type="fix" dev="ggregory" due-to="alhuda, Gary Gregory">Keep RandomStringUtils.random rejection cap from failing valid ranges (#1843).</action>
<action type="fix" dev="ggregory" due-to="Pendela Phanindra Rao, Gary Gregory">[javadoc] Correct hexadecimal output examples in Conversion (#1844).</action>
<action type="fix" dev="ggregory" due-to="Mohd Irshad, Gary Gregory">Fix Conversion hex method Javadoc (#1845).</action>
<action issue="LANG-1423" type="fix" due-to="rys888">Include wrap, wrapIfMissing, and unwrap in the StringUtils class Javadoc overview.</action>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do not edit this file.

@garydgregory
garydgregory marked this pull request as draft November 1, 2026 11:29
Revert the manually added changes.xml entry as requested by the maintainer. Preserve the StringUtils overview documentation.

Assisted-By: OpenAI Codex
@garydgregory
garydgregory marked this pull request as ready for review November 1, 2026 20:50
@garydgregory
garydgregory merged commit 7fbbb71 into apache:master Nov 1, 2026
@garydgregory garydgregory changed the title [LANG-1423] Include wrapping operations in StringUtils overview [LANG-1423] Javadoc: Include wrapping operations in StringUtils overview Nov 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants