8336787: Examine java.text.Format API for implSpec usage

[justin-curtis-lu]

As discussed in https://bugs.openjdk.org/browse/JDK-8335834, there are occurrences in the java.text.Format API that would benefit from the implSpec (and apiNote) tag.

This is a doc-only change, and a CSR has also been filed.

I did not think "Subclasses that support fields should override this and create an ..." sounded right under the implSpec tag, and moved it to an apiNote tag.

---

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

Issues

• JDK-8336787: Examine java.text.Format API for implSpec usage (Bug - P4)
• JDK-8337039: Examine java.text.Format API for implSpec usage (CSR)

Reviewers

• Chen Liang (@liach - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 20303

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

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

@justin-curtis-lu 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:

8336787: Examine java.text.Format API for implSpec usage

Reviewed-by: liach

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

• 476d2ae: 8336831: Optimize StringConcatHelper.simpleConcat
• 4c91d5c: 8322133: getParameterSpec(ECGenParameterSpec.class) on EC AlgorithmParameters does not return standard names
• 2f2223d: 8336944: Shenandoah: Should only relativize stack chunks for successful evacuations
• 8efcb40: 8335823: Update --release 23 symbol information for JDK 23 build 33
• 8e1f17e: 8327054: DiagnosticCommand Compiler.perfmap does not log on output()
• 0e555b5: 8204582: Extra spaces in jlink documentation make it incorrect.
• a2a236f: 8335939: Hide element writing across the ClassFile API
• e83b4b2: 8335182: Consolidate and streamline String concat code shapes
• 4c7b3e7: 8334758: Incorrect note in Javadoc for a few RandomGenerator methods
• 48030a2: 8336855: Duplicate protected declaration and comment in interp_masm_aarch64.hpp
• ... and 5 more: https://git.openjdk.org/jdk/compare/ed6499446dadc339599271a282ceca4a52dbeed4...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.

[openjdk]

@justin-curtis-lu 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 (e01df235)

[justin-curtis-lu]

/integrate

[openjdk]

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

• 4ea4d7c: 8336679: Add @implSpec for the default implementations in Process.waitFor()
• 04e8cb8: 8336815: Several methods in java.net.Socket and ServerSocket do not specify behavior when already bound, connected or closed
• b2599f8: 8336316: JFR: Use SettingControl::getValue() instead of setValue() for ActiveSetting event
• aa15b89: 8336485: jdk/jfr/jcmd/TestJcmdView.java RuntimeException: 'Invoked Concurrent' missing from stdout/stderr
• 332df83: 8336927: Missing equals and hashCode in java.lang.classfile.Annotation
• 05d88de: 8336098: G1: Refactor G1RebuildRSAndScrubTask
• 5b4824c: 8336827: compiler/vectorization/TestFloat16VectorConvChain.java timeouts on ppc64 platforms after JDK-8335860
• 3251eea: 8336499: Failure when creating non-CRT RSA private keys in SunPKCS11
• 476d2ae: 8336831: Optimize StringConcatHelper.simpleConcat
• 4c91d5c: 8322133: getParameterSpec(ECGenParameterSpec.class) on EC AlgorithmParameters does not return standard names
• ... and 13 more: https://git.openjdk.org/jdk/compare/ed6499446dadc339599271a282ceca4a52dbeed4...master

Your commit was automatically rebased without conflicts.

[openjdk]

@justin-curtis-lu Pushed as commit 9e8e359.

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