Skip to content

Fix TextStringBuilder.drainChars for a non-zero start index - #790

Open
dxbjavid wants to merge 1 commit into
apache:masterfrom
dxbjavid:textstringbuilder-drainchars-start-index
Open

dxbjavid wants to merge 1 commit into
apache:masterfrom
dxbjavid:textstringbuilder-drainchars-start-index

Conversation

@dxbjavid

@dxbjavid dxbjavid commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

TextStringBuilder.drainChars(startIndex, endIndex, target, targetIndex) works out how many characters to move and then hands that count to getChars and delete, both of which take an end index rather than a length. The two agree only when startIndex is 0, which is the only shape the existing test tries. With any other start index the method either moves nothing while still reporting a count (new TextStringBuilder("junit").drainChars(2, 4, target, 0) returns 2, but target is untouched and the builder still holds "junit"), moves only part of the range, or throws StringIndexOutOfBoundsException("end < start") for a perfectly valid range such as drainChars(3, 5, target, 0). A caller that trusts the returned count reads whatever was already sitting in the target array as if it were drained text, while the characters it meant to consume stay in the builder. The cap against the builder size has the same slip, since it compares the length with size rather than with the characters remaining after startIndex.

The fix clamps the length against size - startIndex and passes startIndex + actualLen as the end index to getChars and delete, so the startIndex == 0 behaviour and the existing out-of-range exceptions are unchanged. StringSubstitutorReader, the only in-tree caller, always drains from index 0 and is not affected. TextStringBuilderTest#testDrainCharsIntIntCharArrayIntNonZeroStartIndex fails without the main change and passes with it, and the default mvn build is green (2044 tests).


  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute?
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

drainChars computed the number of characters to move and passed that
count to getChars and delete, which both take an end index. The two
only agree when startIndex is 0, so any other start index drained the
wrong range, reported a count it had not copied, or threw
StringIndexOutOfBoundsException for a valid range. Clamp against the
characters after startIndex and pass startIndex + actualLen as the end
index. Add a regression test.
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.

1 participant