8310892: ScopedValue throwing StructureViolationException should be clearer

[AlanBateman]

Docs only update to add a missing @throws StructureViolationException and make it clearer when the exception is thrown. In the future we might re-visit this so that the description is in one place rather than in each method.

---

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

Issues

• JDK-8310892: ScopedValue throwing StructureViolationException should be clearer (Bug - P3)
• JDK-8311024: ScopedValue throwing StructureViolationException should be clearer (CSR)

Reviewers

• Daniel Fuchs (@dfuch - Reviewer)
• Jaikiran Pai (@jaikiran - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14679

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

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

@AlanBateman 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.

[AlanBateman]

/csr

[openjdk]

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

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

[mlbridge]

Webrevs

• 02: Full - Incremental (2e94515d)
• 01: Full - Incremental (08158fe8)
• 00: Full (ab2b91fb)

[dfuch]

I like the new text, it reads well. There's a typo that has been copy pasted several times however.

[AlanBateman]

I like the new text, it reads well. There's a typo that has been copy pasted several times however.

Thanks, I noticed this when looking at the generated javadoc but didn't commit the change to fix. I'll fix it now.

[jaikiran]

Hello Alan, does this mean that the original exception (if any) that caused the completion of the operation would be lost and the caller would instead receive just the StructureViolationException?

[AlanBateman]

No, it's just means the SVE is suppressed - see the discussion in the CSR.

[jaikiran]

Thank you, looks good to me.

[openjdk]

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

8310892: ScopedValue throwing StructureViolationException should be clearer

Reviewed-by: dfuchs, jpai

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

• 06a1a15: 8311588: C2: RepeatCompilation compiler directive does not choose stress seed randomly
• 581f90e: 8311604: Simplify NOCOOPS requested addresses for archived heap objects

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

[dfuch]

LGTM

[AlanBateman]

/integrate

[openjdk]

Going to push as commit 623cfcd.
Since your change was applied there have been 2 commits pushed to the master branch:

• 06a1a15: 8311588: C2: RepeatCompilation compiler directive does not choose stress seed randomly
• 581f90e: 8311604: Simplify NOCOOPS requested addresses for archived heap objects

Your commit was automatically rebased without conflicts.

[openjdk]

@AlanBateman Pushed as commit 623cfcd.

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

[AlanBateman]

/backport jdk21

[openjdk]

@AlanBateman the backport was successfully created on the branch AlanBateman-backport-623cfcd0 in my personal fork of openjdk/jdk21. To create a pull request with this backport targeting openjdk/jdk21:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 623cfcd0 from the openjdk/jdk repository.

The commit being backported was authored by Alan Bateman on 10 Jul 2023 and was reviewed by Daniel Fuchs and Jaikiran Pai.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk21:

$ git fetch https://github.com/openjdk-bots/jdk21.git AlanBateman-backport-623cfcd0:AlanBateman-backport-623cfcd0
$ git checkout AlanBateman-backport-623cfcd0
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk21.git AlanBateman-backport-623cfcd0