ppkarwasz opened a new pull request, #789: URL: https://github.com/apache/commons-io/pull/789
This change makes `AbstractOrigin` implement `Closeable` and updates the Javadoc of all “getter” methods that return `Closeable` resources. The Javadoc now explicitly warns that: * Closing the returned resource will also close the underlying `AbstractOrigin`. * Ownership of the underlying resource is transferred to the caller. ### Rationale * Callers must always close the returned resource. Some implementations create a new resource on each call, which must be released explicitly. * Other implementations return the underlying origin directly, making it impossible to guarantee a close-shielded wrapper. * The primary usage of `AbstractOrigin` is within `AbstractStreamBuilder`, whose implementations typically wrap closeable resources. Before you push a pull request, review this list: - [x] Read the [contribution guidelines](CONTRIBUTING.md) for this project. - [x] Read the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) if you use Artificial Intelligence (AI). - [x] I used AI to generate the Javadoc. - [x] Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself. - [x] 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. - [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why. - [x] 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. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
