Repository navigation
Javadoc: Document how FileInputStream option values are opened - #448
Merged
Merged
Conversation
The default FileInputStream converter, the '<' code in PatternOptionBuilder and TypeHandler.openFile() open the file as soon as the value is converted. The Javadoc didn't say that the caller has to close the stream, or that opening something like a named pipe blocks, just as new FileInputStream(String) does. Document both and add the missing '<' row to the PatternOptionBuilder table. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
|
TY @oscerd merged. The table is missing a heading, but that's a different issue. |
garydgregory
added a commit
that referenced
this pull request
Oct 30, 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
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.
Options of type
FileInputStream(the<code inPatternOptionBuilder, orTypeHandler.openFile()) open the file as soon as the value is converted and hand back an open stream. The Javadoc didn't say that the caller is responsible for closing it, or that opening a special file such as a named pipe blocks, exactly likenew FileInputStream(String)does.This documents both in
TypeHandlerandopenFile(), and adds the missing<row to thePatternOptionBuildertable.Javadoc only, no behavior change.
mvn; that'smvnon the command line by itself.🤖 Generated with Claude Code