8159527: Collections mutator methods should all be marked as optional operations

[stuart-marks]

Adjust the leading javadoc sentence of several collections mutator methods to include "(optional operation)" as appropriate. Also adjust doc for UnsupportedOperationException on those methods as necessary.

---

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
• Change requires CSR request JDK-8313649 to be approved

Issues

• JDK-8159527: Collections mutator methods should all be marked as optional operations (Bug - P3)
• JDK-8313649: Collections mutator methods should all be marked as optional operations (CSR)

Reviewers

• Naoto Sato (@naotoj - Reviewer)
• Brian Burkhalter (@bplb - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15127

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/15127.diff

Webrev

Link to Webrev Comment

[stuart-marks]

/csr

[bridgekeeper]

👋 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]

@stuart-marks has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@stuart-marks this pull request must refer to an issue in JBS to be able to link it to a CSR request. To refer this pull request to an issue in JBS, please update the title of this pull request to just the issue ID.

[openjdk]

@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]

Webrevs

• 00: Full (63f6e695)

[bplb]

Looks fine.

[openjdk]

@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:

8159527: Collections mutator methods should all be marked as optional operations

Reviewed-by: naoto, bpb

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 79 new commits pushed to the master branch:

• 873d117: 8312623: SA add NestHost and NestMembers attributes when dumping class
• 017e0c7: 8310388: Shenandoah: Auxiliary bitmap is not madvised for THP
• f66cd50: 8313564: Fix -Wconversion warnings in classfile code
• e8a37b9: 8313248: C2: setScopedValueCache intrinsic exposes nullptr pre-values to store barriers
• 29f1d8e: 8313707: GHA: Bootstrap sysroots with --variant=minbase
• 61c58fd: 8312976: MatchResult produces StringIndexOutOfBoundsException for groups outside match
• 5d23295: 8313251: Add NativeLibraryLoad event
• c4b8574: 8311938: Add default cups include location for configure on AIX
• 10a2605: 8294979: test/jdk/tools/jlink 3 test classes use ASM library
• e8c325d: 8313394: Array Elements in OldObjectSample event has the incorrect description
• ... and 69 more: https://git.openjdk.org/jdk/compare/c55d29ff119598a410e714ef36f47fb6626a1a7a...master

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.

[stuart-marks]

/integrate

[openjdk]

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

• 873d117: 8312623: SA add NestHost and NestMembers attributes when dumping class
• 017e0c7: 8310388: Shenandoah: Auxiliary bitmap is not madvised for THP
• f66cd50: 8313564: Fix -Wconversion warnings in classfile code
• e8a37b9: 8313248: C2: setScopedValueCache intrinsic exposes nullptr pre-values to store barriers
• 29f1d8e: 8313707: GHA: Bootstrap sysroots with --variant=minbase
• 61c58fd: 8312976: MatchResult produces StringIndexOutOfBoundsException for groups outside match
• 5d23295: 8313251: Add NativeLibraryLoad event
• c4b8574: 8311938: Add default cups include location for configure on AIX
• 10a2605: 8294979: test/jdk/tools/jlink 3 test classes use ASM library
• e8c325d: 8313394: Array Elements in OldObjectSample event has the incorrect description
• ... and 69 more: https://git.openjdk.org/jdk/compare/c55d29ff119598a410e714ef36f47fb6626a1a7a...master

Your commit was automatically rebased without conflicts.

[openjdk]

@stuart-marks Pushed as commit b2add96.

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