8294226: Document missing UnsupportedTemporalTypeException

[gauthamkrishnanibm]

Some methods in the java.time.chrono interfaces—ChronoLocalDate, ChronoLocalDateTime, and ChronoZonedDateTime—override methods from the java.time.temporal.Temporal interface that are documented to throw UnsupportedTemporalTypeException when given unsupported fields or units.

These overridden methods include:

with(TemporalField, long)

plus(long, TemporalUnit)

minus(long, TemporalUnit)

However, their Javadoc in the chrono interfaces does not mention the possibility of this exception, resulting in incomplete or inconsistent documentation. This contrasts with the parent Temporal interface, which explicitly documents the exception.

---

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-8359303 to be approved

Issues

• JDK-8294226: Document missing UnsupportedTemporalTypeException (Bug - P4)
• JDK-8359303: Document missing UnsupportedTemporalTypeException (CSR)

Reviewers

• Roger Riggs (@RogerRiggs - Reviewer)
• Naoto Sato (@naotoj - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25836

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

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

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

8294226: Document missing UnsupportedTemporalTypeException

Reviewed-by: rriggs, naoto

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

• 34412da: 8360179: RISC-V: Only enable BigInteger intrinsics when AvoidUnalignedAccess == false
• a350a11: 8358655: AArch64: Simplify Interpreter::profile_taken_branch
• bcad87e: 8358697: TextLayout/MyanmarTextTest.java passes if no Myanmar font is found
• ... and 132 more: https://git.openjdk.org/jdk/compare/3b32f6a8ec37338764d3e6713247ff96e49bf5b3...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 (@RogerRiggs, @naotoj) 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]

@gauthamkrishnanibm The following labels will be automatically applied to this pull request:

• core-libs
• i18n

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

[mlbridge]

Webrevs

• 00: Full (15558c58)

[RogerRiggs]

Looks good.

[gauthamkrishnanibm]

/integrate

[openjdk]

@gauthamkrishnanibm
Your change (at version 15558c5) is now ready to be sponsored by a Committer.

[RogerRiggs]

/sponsor

[openjdk]

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

• 0514cee: 8360177: ParallelArguments::initialize has incorrect format string
• 28e96e3: 8359920: Use names for frame types in stackmaps
• f5201ac: 8359959: Test runtime/NMT/VirtualAllocTestType.java failed: '\[0x[0]*7f7dc4043000 - 0x[0]*7f7dc4083000\] reserved 256KB for Test' missing from stdout/stderr
• ... and 143 more: https://git.openjdk.org/jdk/compare/3b32f6a8ec37338764d3e6713247ff96e49bf5b3...master

Your commit was automatically rebased without conflicts.

[openjdk]

@RogerRiggs @gauthamkrishnanibm Pushed as commit 54acadb.

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