RFR: 8305748: Clarify reentrant behavior of close() in FileInputStream, FileOutputStream, and RandomAccessFile [v2]

[Archie L. Cobbs]

On Fri, 7 Apr 2023 17:56:30 GMT, Alan Bateman <alanb at openjdk.org> wrote:

>> Archie L. Cobbs has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Apply Javadoc improvements suggested in review.
>
> src/java.base/share/classes/java/io/FileInputStream.java line 503:
> 
>> 501:      *
>> 502:      * @apiNote
>> 503:      * When this stream has an associated channel, this method may invoke
> 
> I don't think a method can have more than one apiNote so the existing note will run into this text. Replacing @apiNote with a paragraph tag will help.
> 
> As regards the wording, then here's a suggestion that relies on the specification and avoids giving the impression that the close method directly calls itself recursively:
> 
> "If this stream has an associated channel then this method will close the channel, which in turn will close this stream. Subclasses that override this method should be prepared to handle possible reentrant invocation."

Thanks - fixed in 90a130783.

> src/java.base/share/classes/java/io/RandomAccessFile.java line 701:
> 
>> 699:      *
>> 700:      * @apiNote
>> 701:      * When this file has an associated channel, this method may invoke
> 
> "this file" should be "this stream"

Thanks - fixed in 90a130783.

@AlanBateman, would you mind reviewing the CSR also? Thanks.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/13379#discussion_r1161124154
PR Review Comment: https://git.openjdk.org/jdk/pull/13379#discussion_r1161124215