RFR: 8310892: ScopedValue throwing StructureViolationException should be clearer

[Daniel Fuchs]

On Tue, 27 Jun 2023 15:34:58 GMT, Alan Bateman <alanb at openjdk.org> wrote:

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

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

src/java.base/share/classes/java/lang/ScopedValue.java line 403:

> 401:          * invoked directly or indirectly by the operation creates a {@link StructuredTaskScope}
> 402:          * but does not {@linkplain StructuredTaskScope#close() close} it, then it is detected
> 403:          * as a <em>structure violation</em> when the operation completes (normally or ith an

Suggestion:

         * as a <em>structure violation</em> when the operation completes (normally or with an

src/java.base/share/classes/java/lang/ScopedValue.java line 433:

> 431:          * invoked directly or indirectly by the operation creates a {@link StructuredTaskScope}
> 432:          * but does not {@linkplain StructuredTaskScope#close() close} it, then it is detected
> 433:          * as a <em>structure violation</em> when the operation completes (normally or ith an

Suggestion:

         * as a <em>structure violation</em> when the operation completes (normally or with an

src/java.base/share/classes/java/lang/ScopedValue.java line 497:

> 495:          * invoked directly or indirectly by the operation creates a {@link StructuredTaskScope}
> 496:          * but does not {@linkplain StructuredTaskScope#close() close} it, then it is detected
> 497:          * as a <em>structure violation</em> when the operation completes (normally or ith an

Suggestion:

         * as a <em>structure violation</em> when the operation completes (normally or with an

src/java.base/share/classes/java/lang/ScopedValue.java line 565:

> 563:      * invoked directly or indirectly by the operation creates a {@link StructuredTaskScope}
> 564:      * but does not {@linkplain StructuredTaskScope#close() close} it, then it is detected
> 565:      * as a <em>structure violation</em> when the operation completes (normally or ith an

Suggestion:

     * as a <em>structure violation</em> when the operation completes (normally or with an

src/java.base/share/classes/java/lang/ScopedValue.java line 601:

> 599:      * invoked directly or indirectly by the operation creates a {@link StructuredTaskScope}
> 600:      * but does not {@linkplain StructuredTaskScope#close() close} it, then it is detected
> 601:      * as a <em>structure violation</em> when the operation completes (normally or ith an

Suggestion:

     * as a <em>structure violation</em> when the operation completes (normally or with an

src/java.base/share/classes/java/lang/ScopedValue.java line 636:

> 634:      * invoked directly or indirectly by the operation creates a {@link StructuredTaskScope}
> 635:      * but does not {@linkplain StructuredTaskScope#close() close} it, then it is detected
> 636:      * as a <em>structure violation</em> when the operation completes (normally or ith an

Suggestion:

     * as a <em>structure violation</em> when the operation completes (normally or with an

-------------

PR Review: https://git.openjdk.org/jdk/pull/14679#pullrequestreview-1501483319
PR Review Comment: https://git.openjdk.org/jdk/pull/14679#discussion_r1244091134
PR Review Comment: https://git.openjdk.org/jdk/pull/14679#discussion_r1244092954
PR Review Comment: https://git.openjdk.org/jdk/pull/14679#discussion_r1244093522
PR Review Comment: https://git.openjdk.org/jdk/pull/14679#discussion_r1244094318
PR Review Comment: https://git.openjdk.org/jdk/pull/14679#discussion_r1244095201
PR Review Comment: https://git.openjdk.org/jdk/pull/14679#discussion_r1244095763