sharanggupta opened a new pull request, #748: URL: https://github.com/apache/commons-collections/pull/748
Fixes [COLLECTIONS-732](https://issues.apache.org/jira/browse/COLLECTIONS-732). **What** `MultiValuedMap.mapIterator()` returns an iterator whose `setValue(Object)` always throws `UnsupportedOperationException` (the `MultiValuedMapEntry` instances it iterates are read-only), but neither the interface Javadoc nor the implementation said so, which is what the ticket asked for; @kinow invited a Javadoc PR there in 2020. **How** Javadoc only, no code change: - `MultiValuedMap#mapIterator()`: says that the iterator visits one key-value mapping at a time, that the implementations in this library do not support `MapIterator#setValue(Object)` and throw `UnsupportedOperationException` from it, and how to replace a value instead (`remove()`/`removeMapping` + `put`). - `AbstractMultiValuedMap#mapIterator()`: `{@inheritDoc}` plus the same note for this implementation. - `AbstractMultiValuedMap.MultiValuedMapIterator#setValue(Object)`: documents the `IllegalStateException` before `next()` and the `UnsupportedOperationException` otherwise. The behaviour itself is already pinned by `AbstractMultiValuedMapTest.testMapIteratorUnsupportedSet`, so no test was added. Verified locally with the default `mvn` goal on Java 17 (full test suite: 22,257 tests, plus RAT, Javadoc, japicmp, Checkstyle and PMD). 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 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? Claude (Anthropic) helped draft the Javadoc wording; I reviewed it against the code and ran the build. - [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]
