Re: RFR: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
On Wed, 13 Oct 2021 17:43:29 GMT, Lance Andersen wrote: > Hi all, > > Please review the fix to address a javadoc issue for the Deflater::deflate > methods that were added as part of JDK-6341887 that could throw a > ReadOnlyBufferException. > > The` @throws ` clause for `ReadOnlyBufferException` was inadvertently > omitted from the javadoc for these new methods. > > A CSR, JDK-8275164, has also been created for this issue. > > Best > Lance Marked as reviewed by naoto (Reviewer). - PR: https://git.openjdk.java.net/jdk/pull/5931
Re: RFR: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
On Wed, 13 Oct 2021 18:20:03 GMT, Brian Burkhalter wrote: >> Hi all, >> >> Please review the fix to address a javadoc issue for the Deflater::deflate >> methods that were added as part of JDK-6341887 that could throw a >> ReadOnlyBufferException. >> >> The` @throws ` clause for `ReadOnlyBufferException` was inadvertently >> omitted from the javadoc for these new methods. >> >> A CSR, JDK-8275164, has also been created for this issue. >> >> Best >> Lance > > src/java.base/share/classes/java/util/zip/Deflater.java line 498: > >> 496: * @return the actual number of bytes of compressed data written to >> the >> 497: * output buffer >> 498: * @throws ReadOnlyBufferException if the given output buffer is >> read-only > > It could equally well simply state > > if the buffer is read-only > > but this is fine. I thought about that but I decided to go with the wording used for the change to Inflater::inflate that was added as part of JDK-6341887. If I were to change it, I would want to change Inflater::inflate as well. - PR: https://git.openjdk.java.net/jdk/pull/5931
Re: RFR: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
On Wed, 13 Oct 2021 18:24:39 GMT, Lance Andersen wrote: >> src/java.base/share/classes/java/util/zip/Deflater.java line 498: >> >>> 496: * @return the actual number of bytes of compressed data written >>> to the >>> 497: * output buffer >>> 498: * @throws ReadOnlyBufferException if the given output buffer is >>> read-only >> >> It could equally well simply state >> >> if the buffer is read-only >> >> but this is fine. > > I thought about that but I decided to go with the wording used for the > change to Inflater::inflate that was added as part of JDK-6341887. If I were > to change it, I would want to change Inflater::inflate as well. I retract my previous comment: I think you made the correct decision. - PR: https://git.openjdk.java.net/jdk/pull/5931
Re: RFR: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
On Wed, 13 Oct 2021 17:43:29 GMT, Lance Andersen wrote: > Hi all, > > Please review the fix to address a javadoc issue for the Deflater::deflate > methods that were added as part of JDK-6341887 that could throw a > ReadOnlyBufferException. > > The` @throws ` clause for `ReadOnlyBufferException` was inadvertently > omitted from the javadoc for these new methods. > > A CSR, JDK-8275164, has also been created for this issue. > > Best > Lance Associated CSR also Reviewed. - Marked as reviewed by iris (Reviewer). PR: https://git.openjdk.java.net/jdk/pull/5931
Re: RFR: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
On Wed, 13 Oct 2021 17:43:29 GMT, Lance Andersen wrote: > Hi all, > > Please review the fix to address a javadoc issue for the Deflater::deflate > methods that were added as part of JDK-6341887 that could throw a > ReadOnlyBufferException. > > The` @throws ` clause for `ReadOnlyBufferException` was inadvertently > omitted from the javadoc for these new methods. > > A CSR, JDK-8275164, has also been created for this issue. > > Best > Lance Marked as reviewed by bpb (Reviewer). src/java.base/share/classes/java/util/zip/Deflater.java line 498: > 496: * @return the actual number of bytes of compressed data written to > the > 497: * output buffer > 498: * @throws ReadOnlyBufferException if the given output buffer is > read-only It could equally well simply state if the buffer is read-only but this is fine. - PR: https://git.openjdk.java.net/jdk/pull/5931
RFR: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
Hi all, Please review the fix to address a javadoc issue for the Deflater::deflate methods that were added as part of JDK-6341887 that could throw a ReadOnlyBufferException. The` @throws ` clause for `ReadOnlyBufferException` was inadvertently omitted from the javadoc for these new methods. A CSR, JDK-8275164, has also been created for this issue. Best Lance - Commit messages: - Add missing @throws for ReadOnlyBufferException Changes: https://git.openjdk.java.net/jdk/pull/5931/files Webrev: https://webrevs.openjdk.java.net/?repo=jdk=5931=00 Issue: https://bugs.openjdk.java.net/browse/JDK-8275163 Stats: 2 lines in 1 file changed: 2 ins; 0 del; 0 mod Patch: https://git.openjdk.java.net/jdk/pull/5931.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/5931/head:pull/5931 PR: https://git.openjdk.java.net/jdk/pull/5931
