RFR: 8306431: File.listRoots method description should be re-examined [v5]

[Alan Bateman]

On Tue, 16 May 2023 01:34:45 GMT, Nagata-Haruhito <duke at openjdk.org> wrote:

>> I fixed File.listRoots description.
>> * remove "the insertion or ejection of removable media"
>> * change "available" to "existing"
>> 
>> Please review this change.
>
> Nagata-Haruhito has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains four additional commits since the last revision:
> 
>  - Merge branch 'openjdk:master' into File_javadoc
>  - Merge branch 'openjdk:master' into File_javadoc
>  - 8306431: The documentation of File.listRoots should be modifid after JDK-8208077
>  - 8306431: File.listRoots method description should be re-examined

src/java.base/share/classes/java/io/File.java line 1819:

> 1817:      *
> 1818:      * <p> This method returns an array of {@code File} objects that denote the
> 1819:      * root directories of the existing filesystem roots.  It is guaranteed

I don't think you can change "available" to "existing" here without a lot more discussion. In particular, the javadoc can't set the expectation that "existing" implies that File::exists will return true, it might not. So I think drop this from the change.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/13526#discussion_r1194695909