8179918: EnumSet spliterator should report SORTED, ORDERED, NONNULL

[kilink]

I noticed that the Spliterator for EnumSet does not report SORTED, ORDERED, or NONNULL characteristics, all of which are inherent to API of EnumSet. I found there's an existing ticket for this as well.

The ticket also mentions optimized forEach, etc, which I presume means avoiding the default implementation that uses the iterator and just iterating over the bitset directly; I can add that here or perhaps in a follow up if it's still deemed worthwhile.

---

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-8179918: EnumSet spliterator should report SORTED, ORDERED, NONNULL (Bug - P3)

Reviewers

• Viktor Klang (@viktorklang-ora - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28568

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

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

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

8179918: EnumSet spliterator should report SORTED, ORDERED, NONNULL

Reviewed-by: vklang

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

• 520c092: 8362658: sun/security/ssl/SSLEngineImpl/* tests duplicate jvm flags
• 4d696d0: 8373086: Make isexceeded001.java more robust
• ee0b8a7: 8373102: com/sun/jdi/MethodInvokeWithTraceOnTest.java can fail with ObjectCollectedException when run with a small heap
• ... and 133 more: https://git.openjdk.org/jdk/compare/92e1357dfd2d874ef1a62ddd69c86a7bb189c6a2...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 (@viktorklang-ora) 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).

[openjdk]

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

• 06: Full - Incremental (adb01836)
• 05: Full - Incremental (98bcd8b4)
• 04: Full - Incremental (bcc973eb)
• 03: Full - Incremental (5750b26a)
• 02: Full - Incremental (9e7a1c50)
• 01: Full - Incremental (bbce28c3)
• 00: Full (1d4eba6b)

[viktorklang-ora]

Hi @kilink,

This PR is currently missing a test case or two.

[kilink]

Hi @kilink,

This PR is currently missing a test case or two.

I've added a basic unit test that verifies the spliterator characteristics as well as the encounter order, let me know if you think that's sufficient. Thanks!

[viktorklang-ora]

Thanks for adding the test. I think it makes sense to check the enumSet.spliterator().characteristics() being exactly DISTINCT | SORTED | ORDERED | NONNULL (since this test otherwise would still pass if further characteristics are added).

[kilink]

Okay, I also check for SIZED / SUBSIZED since those get added by Spliterators.spliterator. I left each check split out though to make it easier to see exactly why the test fails if there's a regression.

[openjdk]

@kilink Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

[viktorklang-ora]

For the sake of completeness, it probably makes sense to test the characteristics of EnumSet.of(…), EnumSet.range(…), and EnumSet.noneOf(…) as well.

[viktorklang-ora]

Thanks for this, @kilink!

[kilink]

/integrate

[openjdk]

@kilink
Your change (at version adb0183) is now ready to be sponsored by a Committer.

[kilink]

Thank you for the review / feedback @viktorklang-ora . Would you be willing to sponsor this change? Thanks!

[viktorklang-ora]

/sponsor

[openjdk]

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

• b0f59f6: 8373127: Update nsk/monitoring tests to support virtual thread factory testing
• 2596608: 8370846: Support execution of mlvm testing with test thread factory
• be8cbfa: 8362083: JDI VirtualMachine/dispose/dispose001 failed with FATAL ERROR in native method: JDWP cannot set thread local storage, jvmtiError=JVMTI_ERROR_WRONG_PHASE(112)
• ... and 139 more: https://git.openjdk.org/jdk/compare/92e1357dfd2d874ef1a62ddd69c86a7bb189c6a2...master

Your commit was automatically rebased without conflicts.

[openjdk]

@viktorklang-ora @kilink Pushed as commit 5f083ab.

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

[jddarcy]

Hmm. Catching up on reviews, should the behavior change here get a CSR? More broader, should there be an implSpec change under a follow-up bug and CSR that requires this behavior?

[viktorklang-ora]

@jddarcy Seems reasonable! Chasing down the super-implementation, Set::spliterator() states that overloads should report their characteristics (even if the documentation linked does seem to unnecessarily convolutedly state which characteristics the default implementation provides). I can open up a new Issue and handle the CSR-bits if @kilink doesn't mind?

[kilink]

@jddarcy Seems reasonable! Chasing down the super-implementation, Set::spliterator() states that overloads should report their characteristics (even if the documentation linked does seem to unnecessarily convolutedly state which characteristics the default implementation provides). I can open up a new Issue and handle the CSR-bits if @kilink doesn't mind?

Sounds good to me, thanks! Also, apologies, it hadn't occurred to me that this would require an update to the javadocs. The existing docs do specify that the Iterator returns elements in their natural order, and that null is not permitted, so one could say that it's implied that the spliterator would also have those characteristics. But I do see now that you pointed it out that Set indicates implementations should document any additional characteristics.