RFR: JDK-8262435: Clarify the behavior of a few inherited ZipInputStream methods [v2]

Alan Bateman alanb at openjdk.org
Fri Nov 11 17:48:29 UTC 2022


On Fri, 11 Nov 2022 17:16:38 GMT, Lance Andersen <lancea at openjdk.org> wrote:

>> Please review the following PR which updates several of the ZipInputStream methods whose javadoc is inherited to clarify the methods  are acting on  the current ZIP Entry.
>> 
>> There are no changes in behavior.  The main description for the method's javadoc that has been copied has been clarified and the remaining doc is the same.
>
> Lance Andersen has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Addressed latest set of input on the javadoc

I think it would be useful to generate the javadoc and see if there are terminology or wording differences between the existing and new descriptions being copied down from input stream.

For example, the no-arg read is "Reads a byte of uncompressed data from the input stream for the current ZIP entry"  where the 3-arg read is "Reads from the current ZIP entry into an array of bytes, returning the number of inflated bytes".  So one speaks of reading from the input stream, the other of reading from the current the ZIP entry. One speaks of reading uncompressed data, the other is returning inflated bytes. Another example is the skip methods. The no-arg skip speaks of skipping bytes in the current ZIP entry. The skipNBytes speaks of skipping and discard bytes of data from the input stream. The available method might need attention too because it it specified a result for when EOF for the current entry data is reached.

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

PR: https://git.openjdk.org/jdk/pull/10995


More information about the core-libs-dev mailing list