On Wed, 13 May 2026 10:57:12 GMT, Alan Bateman <[email protected]> wrote:

>> Jaikiran Pai 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 17 additional 
>> commits since the last revision:
>> 
>>  - merge latest from master branch
>>  - merge latest from master branch
>>  - minor adjustments
>>  - Lance's review
>>  - merge latest from master branch
>>  - introduce test to verify read() throws IOException when invoked on closed 
>> stream
>>  - specify existing behaviour of throwing IOException when stream is already 
>> closed
>>  - merge latest from master branch
>>  - specify that GZIPInputStream is not thread-safe
>>  - refer to section 2.2 of the RFC
>>  - ... and 7 more: https://git.openjdk.org/jdk/compare/80a78b38...a22c1b83
>
> src/java.base/share/classes/java/util/zip/GZIPInputStream.java line 182:
> 
>> 180:      * @implSpec After reading a member trailer, this method calls 
>> {@link InputStream#available()}
>> 181:      * on the underlying stream to determine whether additional data is 
>> available that may represent
>> 182:      * a subsequent member.
> 
> Who is the audience for this? Usually implSpec is aim at 
> implementers/subclasses. Here I think this note is aimed at the user of the 
> API that provides the input stream.

It's for both, the users/callers of the GZIPInputStream who pass in the 
underlying InputStream when constructing the GZIPInputStream instance and for 
any libraries which may subclass this class.

But to me it's always a bit of a dilemma when it comes to the usage of 
`@apiNote`, `@implSpec` (and sometimes `@implNote`). Do you suggest using 
`@apiNote` here?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/30925#discussion_r3252434152

Reply via email to