8289779: Map::replaceAll javadoc has redundant @throws clauses #111

stuart-marks · 2022-07-06T00:32:00Z

Simple javadoc fix of an editorial nature.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8289779: Map::replaceAll javadoc has redundant @throws clauses

Reviewers

Pavel Rappo (@pavelrappo - Reviewer)
Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk19 pull/111/head:pull/111
$ git checkout pull/111

Update a local copy of the PR:
$ git checkout pull/111
$ git pull https://git.openjdk.org/jdk19 pull/111/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 111

View PR using the GUI difftool:
$ git pr show -t 111

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk19/pull/111.diff

bridgekeeper · 2022-07-06T00:33:40Z

👋 Welcome back smarks! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2022-07-06T00:37:42Z

@stuart-marks The following label will be automatically applied to this pull request:

core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

mlbridge · 2022-07-06T00:42:13Z

Webrevs

01: Full - Incremental (a3fbdb5b)
00: Full (8902f466)

AlanBateman · 2022-07-06T06:23:31Z

src/java.base/share/classes/java/util/Map.java

-     * @throws NullPointerException if function or a replacement value is null,
-     *         and this map does not permit null keys or values
+     * @throws NullPointerException if the specified function is null, or if a replacement value is null
+     *         and this map does not permit null values


This looks okay although I'd probably reflow L744-745 to avoid to keep the line lengths somewhat consistent with the other exceptions.

pavelrappo

Thanks for doing this, Stuart. Not only does this PR remove duplication from the Map documentation, but it also ensures that when JDK-6509045 is integrated, that duplication won't spread to ConcurrentMap. A bonus of this fix is that the irrelevant mention of "keys" is gone from the description of NullPointerException.

Also, consider closing 8255426 as a duplicate.

openjdk · 2022-07-06T08:42:03Z

@stuart-marks This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8289779: Map::replaceAll javadoc has redundant @throws clauses

Reviewed-by: prappo, iris

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 9 new commits pushed to the master branch:

889150b: 8289558: Need spec clarification of j.l.foreign.*Layout
8dd94a2: 8289196: Pattern domination not working properly for record patterns
8f24d25: 6509045: {@inheritdoc} only copies one instance of the specified exception
9a0fa82: 8288949: serviceability/jvmti/vthread/ContStackDepthTest/ContStackDepthTest.java failing
55fa19b: 8289857: ProblemList jdk/jfr/event/runtime/TestActiveSettingEvent.java
32b650c: 8289840: ProblemList vmTestbase/nsk/jdwp/ThreadReference/ForceEarlyReturn/forceEarlyReturn002/forceEarlyReturn002.java when run with vthread wrapper
ef3f2ed: 8289841: ProblemList vmTestbase/gc/gctests/MemoryEaterMT/MemoryEaterMT.java with ZGC on windows
0526402: 8289477: Memory corruption with CPU_ALLOC, CPU_FREE on muslc
b3a0e48: 8289439: Clarify relationship between ThreadStart/ThreadEnd and can_support_virtual_threads capability

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

irisclark · 2022-07-06T19:08:32Z

src/java.base/share/classes/java/util/Map.java

@@ -739,21 +739,16 @@ default void forEach(BiConsumer<? super K, ? super V> action) {
     * @throws UnsupportedOperationException if the {@code set} operation
     * is not supported by this map's entry set iterator.


Maybe fix indentation here and at line 742 for the CCE for consistency?

stuart-marks · 2022-07-06T23:07:02Z

Reflowed and adjusted whitespace.

Also, Pavel wrote:

Also, consider closing 8255426 as a duplicate.

Ha! Thanks, I had forgotten about that one. Easier to file a new bug than to dig out an old one. Oh well, closed as duplicate.

stuart-marks · 2022-07-07T16:53:11Z

/integrate

openjdk · 2022-07-07T16:54:23Z

Going to push as commit a8eb728.
Since your change was applied there have been 9 commits pushed to the master branch:

889150b: 8289558: Need spec clarification of j.l.foreign.*Layout
8dd94a2: 8289196: Pattern domination not working properly for record patterns
8f24d25: 6509045: {@inheritdoc} only copies one instance of the specified exception
9a0fa82: 8288949: serviceability/jvmti/vthread/ContStackDepthTest/ContStackDepthTest.java failing
55fa19b: 8289857: ProblemList jdk/jfr/event/runtime/TestActiveSettingEvent.java
32b650c: 8289840: ProblemList vmTestbase/nsk/jdwp/ThreadReference/ForceEarlyReturn/forceEarlyReturn002/forceEarlyReturn002.java when run with vthread wrapper
ef3f2ed: 8289841: ProblemList vmTestbase/gc/gctests/MemoryEaterMT/MemoryEaterMT.java with ZGC on windows
0526402: 8289477: Memory corruption with CPU_ALLOC, CPU_FREE on muslc
b3a0e48: 8289439: Clarify relationship between ThreadStart/ThreadEnd and can_support_virtual_threads capability

Your commit was automatically rebased without conflicts.

openjdk · 2022-07-07T16:54:38Z

@stuart-marks Pushed as commit a8eb728.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

8289779: Map::replaceAll javadoc has redundant @throws clauses

8902f46

openjdk bot added the rfr Pull request is ready for review label Jul 6, 2022

openjdk bot added the core-libs core-libs-dev@openjdk.org label Jul 6, 2022

AlanBateman reviewed Jul 6, 2022

View reviewed changes

pavelrappo approved these changes Jul 6, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jul 6, 2022

irisclark reviewed Jul 6, 2022

View reviewed changes

irisclark approved these changes Jul 6, 2022

View reviewed changes

Reflow and adjust whitespace per Alan's & Iris' comments.

a3fbdb5

irisclark approved these changes Jul 6, 2022

View reviewed changes

pavelrappo approved these changes Jul 7, 2022

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Jul 7, 2022

openjdk bot closed this Jul 7, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jul 7, 2022

8289779: Map::replaceAll javadoc has redundant @throws clauses #111

8289779: Map::replaceAll javadoc has redundant @throws clauses #111

stuart-marks commented Jul 6, 2022 •

edited by openjdk bot

bridgekeeper bot commented Jul 6, 2022

openjdk bot commented Jul 6, 2022

mlbridge bot commented Jul 6, 2022 •

edited

AlanBateman Jul 6, 2022

pavelrappo left a comment

openjdk bot commented Jul 6, 2022 •

edited

irisclark Jul 6, 2022 •

edited

stuart-marks commented Jul 6, 2022

stuart-marks commented Jul 7, 2022

openjdk bot commented Jul 7, 2022

openjdk bot commented Jul 7, 2022

		@@ -739,21 +739,16 @@ default void forEach(BiConsumer<? super K, ? super V> action) {
		* @throws UnsupportedOperationException if the {@code set} operation
		* is not supported by this map's entry set iterator.

8289779: Map::replaceAll javadoc has redundant @throws clauses #111

8289779: Map::replaceAll javadoc has redundant @throws clauses #111

Conversation

stuart-marks commented Jul 6, 2022 • edited by openjdk bot

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Jul 6, 2022

openjdk bot commented Jul 6, 2022

mlbridge bot commented Jul 6, 2022 • edited

Webrevs

AlanBateman Jul 6, 2022

Choose a reason for hiding this comment

pavelrappo left a comment

Choose a reason for hiding this comment

openjdk bot commented Jul 6, 2022 • edited

irisclark Jul 6, 2022 • edited

Choose a reason for hiding this comment

stuart-marks commented Jul 6, 2022

stuart-marks commented Jul 7, 2022

openjdk bot commented Jul 7, 2022

openjdk bot commented Jul 7, 2022

stuart-marks commented Jul 6, 2022 •

edited by openjdk bot

mlbridge bot commented Jul 6, 2022 •

edited

openjdk bot commented Jul 6, 2022 •

edited

irisclark Jul 6, 2022 •

edited