RFR: 8340466: Add description for PassFailJFrame constructors [v2]

Harshitha Onkar honkar at openjdk.org
Tue Sep 24 23:38:37 UTC 2024


On Tue, 24 Sep 2024 16:12:29 GMT, Alexey Ivanov <aivanov at openjdk.org> wrote:

>> I added description to all the constructors available in `PassFailJFrame`.
>> 
>> I generated the javadoc for it: [`PassFailJFrame` constructor details](https://cr.openjdk.org/~aivanov/PassFailJFrame/api/PassFailJFrame.html#constructor-detail) which is easier to read. This hosted javadoc could be used as a reference to its API.
>> 
>> The constructor with the largest number of parameters contains a short description of how to use the `PassFailJFrame` object.
>> 
>> Shall we deprecate the constructors in favour of `Builder`?
>> 
>> The builder provides a more streamlined experience, therefore new tests should use it instead of constructors. We may update the tests which use the constructors, after which the constructors can be removed.
>
> Alexey Ivanov has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Use EDT abbreviation in constructor description
>   
>   The term EDT (Event Dispatch Thread) is introduced in
>   the top-level doc comment.

> Shall we deprecate the constructors in favor of Builder?

>The builder provides a more streamlined experience, therefore new tests should use it instead of constructors. We may update the tests which use the constructors, after which the constructors can be removed.

There are some cases where the builder approach may not work as expected especially modal dialog tests and  in such instances the older constructor methods are used.

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

PR Review: https://git.openjdk.org/jdk/pull/21145#pullrequestreview-2326697452


More information about the client-libs-dev mailing list