RFR: 8355441: Remove antipattern from PassFailJFrame.forcePass javadoc [v4]

Harshitha Onkar honkar at openjdk.org
Mon Apr 28 21:02:45 UTC 2025


On Sat, 26 Apr 2025 01:28:53 GMT, Manukumar V S <mvs at openjdk.org> wrote:

>> The javadoc for PassFailJFrame.forcePass suggests an anti-pattern of forcibly passing the test if a resource is unavailable.
>> 
>> If a resource is unavailable or a feature isn't supported, the test should throw jtreg.SkippedException.
>> 
>> PassFailJFrame.forcePass should be used in semi-automatic tests when the test determines that all the conditions for passing the test are met.
>> Please refer: JDK-8355366 and https://github.com/openjdk/jdk/pull/24820
>> 
>> Testing
>> This is a javadoc change, so not testing required.
>
> Manukumar V S has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Updated line number in code link

test/jdk/java/awt/regtesthelpers/PassFailJFrame.java line 1306:

> 1304:      * <p>A sample usage can be found in
> 1305:      * <a href="https://github.com/openjdk/jdk/blob/7283c8b/test/jdk/java/awt/FileDialog/SaveFileNameOverrideTest.java#L84">{@code
> 1306:      * SaveFileNameOverrideTest.java}</a>

Javadoc update LGTM. Maybe the doc for forceFail() can be updated similarly?
@aivanov-jdk What do you suggest?

It can be done as a part of this PR change or a separate PR. Since it is a similar doc change, I think it can be done as part of this PR by the changing the JBS title appropriately  - _Update javadocs for PassFailJFrame's forcePass() & forceFail() methods_

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

PR Review Comment: https://git.openjdk.org/jdk/pull/24837#discussion_r2064692150


More information about the client-libs-dev mailing list