[IO-855] Clarify PeekableInputStream.peek() behavior in Javadoc#856
Merged
garydgregory merged 1 commit intoJun 11, 2026
Conversation
Add tests for exact-match and non-consuming behavior.
garydgregory
changed the title
garydgregory
added a commit
that referenced
this pull request
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PeekableInputStream.peek() currently performs an exact match against the provided byte array, but the Javadoc could be read as a prefix / starts-with check.
This PR clarifies the Javadoc to state that peek() requires an exact match and does not consume bytes from the stream.
It also adds tests covering:
Resolves IO-855
Checklist:
mvn -Drat.skip=true -Dtest=PeekableInputStreamTest test