8373243 : EnumSet.spliterator() should specify and document its characteristics

[viktorklang-ora]

Addresses https://bugs.openjdk.org/browse/JDK-8373243 by copying and adapting the specification from https://github.com/openjdk/jdk/blob/master/src/java.base/share/classes/java/util/LinkedHashSet.java#L186-L204

Since EnumSet is sealed and only permits two final classes, the verbiage around "Implementations should document the reporting of additional characteristic values." may be considered to get removed from this PR. Kept, for now, for symmetry reasons.

---

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 a CSR request matching fixVersion 27 to be approved (needs to be created)

Issue

• JDK-8373243: EnumSet.spliterator() should specify and document its characteristics (Bug - P4)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28696

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[viktorklang-ora]

Tagging @jddarcy here since this issue was raised by him.

[bridgekeeper]

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

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

[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.

[mlbridge]

Webrevs

• 02: Full - Incremental (6a588fcd)
• 01: Full - Incremental (780252ca)
• 00: Full (3b485d7c)

[jddarcy]

/csr needed

[openjdk]

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

@viktorklang-ora please create a CSR request for issue JDK-8373243 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

[jddarcy]

PS Is there anything analagous that should be added to any of the methods on EnumMap about the properties of the returned collections?

[kilink]

I don't think the EnumSet spliterator is fail-fast, since its iterator is weakly consistent.