JDK-8151531: Add notes to BaseStream.spliterator/iterator docs regarding them being escape hatches

[viktorklang-ora]

Still relevant to address? /cc @PaulSandoz

---

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-8151531: Add notes to BaseStream.spliterator/iterator docs regarding them being escape hatches

Reviewers

• Paul Sandoz (@PaulSandoz - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13890

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back viktorklang-ora! 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]

@viktorklang-ora 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.

[PaulSandoz]

I would recommend:

• using @apiNote (might have to be placed at the end of the documentation); and
• say "This operation is provided ..."

[mlbridge]

Webrevs

• 02: Full - Incremental (3f1cb743)
• 01: Full - Incremental (4739a781)
• 00: Full (5082a0f5)

[viktorklang-ora]

@PaulSandoz Makes a lot of sense. Done.

[openjdk]

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

8151531: Add notes to BaseStream.spliterator/iterator docs regarding them being escape hatches

Reviewed-by: psandoz

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

• 0198afc: 8305748: Clarify reentrant behavior of close() in FileInputStream, FileOutputStream, and RandomAccessFile
• 1bca05e: 8307799: Newly added java/awt/dnd/MozillaDnDTest.java has invalid jtreg @requires clause
• cc39689: 8300245: Replace NULL with nullptr in share/jfr/
• 4251b56: 8306843: JVMTI tag map extremely slow after JDK-8292741
• ab34cb9: 8305082: Remove finalize() from test/hotspot/jtreg/runtime/linkResolver/InterfaceObjectTest.java
• 0da48f1: 8307732: build-test-lib is broken
• 4aa65cb: 8285932: Implementation of JEP 430 String Templates (Preview)
• da2c930: 8302845: Replace finalizer usage in JNDI DNS provider with Cleaner
• 540c706: 8307348: Parallelize heap walk for ObjectCount(AfterGC) JFR event collection
• d993432: 8306930: Incorrect assert in BitMap::count_one_bits
• ... and 14 more: https://git.openjdk.org/jdk/compare/5842fd5beb13f3458f61df7e7480a54bd2157253...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@PaulSandoz) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[viktorklang-ora]

/integrate

[openjdk]

@viktorklang-ora
Your change (at version 4739a78) is now ready to be sponsored by a Committer.

[viktorklang-ora]

@PaulSandoz Forgot to update copyright year so added that as well

[PaulSandoz]

/sponsor

[openjdk]

@PaulSandoz The PR has been updated since the change author (@viktorklang-ora) issued the integrate command - the author must perform this command again.

[viktorklang-ora]

/integrate

[openjdk]

@viktorklang-ora
Your change (at version 3f1cb74) is now ready to be sponsored by a Committer.

[PaulSandoz]

/sponsor

[openjdk]

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

• 0198afc: 8305748: Clarify reentrant behavior of close() in FileInputStream, FileOutputStream, and RandomAccessFile
• 1bca05e: 8307799: Newly added java/awt/dnd/MozillaDnDTest.java has invalid jtreg @requires clause
• cc39689: 8300245: Replace NULL with nullptr in share/jfr/
• 4251b56: 8306843: JVMTI tag map extremely slow after JDK-8292741
• ab34cb9: 8305082: Remove finalize() from test/hotspot/jtreg/runtime/linkResolver/InterfaceObjectTest.java
• 0da48f1: 8307732: build-test-lib is broken
• 4aa65cb: 8285932: Implementation of JEP 430 String Templates (Preview)
• da2c930: 8302845: Replace finalizer usage in JNDI DNS provider with Cleaner
• 540c706: 8307348: Parallelize heap walk for ObjectCount(AfterGC) JFR event collection
• d993432: 8306930: Incorrect assert in BitMap::count_one_bits
• ... and 14 more: https://git.openjdk.org/jdk/compare/5842fd5beb13f3458f61df7e7480a54bd2157253...master

Your commit was automatically rebased without conflicts.

[openjdk]

@PaulSandoz @viktorklang-ora Pushed as commit 8a95020.

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