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

[Lance Andersen]

On Mon, 7 Nov 2022 09:58:03 GMT, Jaikiran Pai <jpai 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.
>
> src/java.base/share/classes/java/util/zip/ZipInputStream.java line 231:
> 
>> 229:      *
>> 230:      * @throws OutOfMemoryError {@inheritDoc}
>> 231:      *
> 
> I suspect we will also need to explicitly have a `@throws IOException` here.

The javadoc  for the checked exceptions will be inherited.  I had to specifically add the RuntimeExceptions as they are not inherited by default

> src/java.base/share/classes/java/util/zip/ZipInputStream.java line 242:
> 
>> 240:      * Reads up to a specified number of bytes from the input stream
>> 241:      * for the current ZIP entry. This
>> 242:      * method blocks until the requested number of bytes has been read, end
> 
> Nit - some of these words could be moved to the previous line to make the line length consistent with other lines.

I had addressed it but had not pushed it, thanks for the reminder

> src/java.base/share/classes/java/util/zip/ZipInputStream.java line 276:
> 
>> 274:      * the result is bounded by {@code 2*(long)len}, inclusive.
>> 275:      *
>> 276:      *  @throws OutOfMemoryError {@inheritDoc}
> 
> There are a couple of other `@throws` in the `super` that I think we should inherit here.

See comment above, checked exceptions are inherited

> src/java.base/share/classes/java/util/zip/ZipInputStream.java line 319:
> 
>> 317:      *
>> 318:      * @throws NullPointerException {@inheritDoc}
>> 319:      * @throws IndexOutOfBoundsException {@inheritDoc}
> 
> Missing `@throws` for `IOException`.

See comment above, checked exceptions are inherited

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

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