Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException #5931

Closed
wants to merge 1 commit into from

Conversation

LanceAndersen
Copy link
Contributor

@LanceAndersen LanceAndersen commented Oct 13, 2021

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


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/5931/head:pull/5931
$ git checkout pull/5931

Update a local copy of the PR:
$ git checkout pull/5931
$ git pull https://git.openjdk.java.net/jdk pull/5931/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5931

View PR using the GUI difftool:
$ git pr show -t 5931

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/5931.diff

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Oct 13, 2021

👋 Welcome back lancea! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot changed the title 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException Oct 13, 2021
@openjdk openjdk bot added the rfr label Oct 13, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Oct 13, 2021

@LanceAndersen The following label will be automatically applied to this pull request:

  • core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the core-libs label Oct 13, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Oct 13, 2021

Webrevs

@@ -495,6 +495,7 @@ public int deflate(byte[] output) {
* @param output the buffer for the compressed data
* @return the actual number of bytes of compressed data written to the
* output buffer
* @throws ReadOnlyBufferException if the given output buffer is read-only
Copy link
Member

@bplb bplb Oct 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It could equally well simply state

if the buffer is read-only

but this is fine.

Copy link
Contributor Author

@LanceAndersen LanceAndersen Oct 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@bplb bplb Oct 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I retract my previous comment: I think you made the correct decision.

bplb
bplb approved these changes Oct 13, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Oct 13, 2021

@LanceAndersen This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException

Reviewed-by: bpb, iris, naoto

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 36 new commits pushed to the master branch:

  • f178185: 8275249: Suppress warnings on non-serializable array component types in jdk.jlink
  • ee64ce9: 8274937: Revert the timeout setting for DynamicLoaderConstraintsTest
  • 8c4da9c: 8275013: Improve discussion of serialization method declarations in java.io.Object{Input, Output}Stream
  • da8da3a: 8269698: Specification for methods of java.awt.im.InputContext should mention that they do nothing
  • 8e02064: 8049520: FileCredentialsCache loads cache once and is never refreshed
  • 172aed1: 8274338: com/sun/jdi/RedefineCrossEvent.java failed "assert(m != __null) failed: NULL mirror"
  • ced7909: 8275286: Check current thread when calling JRT methods that expect it
  • c0f3e1d: 8271071: accessibility of a table on macOS lacks cell navigation
  • 4cb7124: 8262912: ciReplay: replay does not simulate unresolved classes
  • 322b130: 8275106: Cleanup Iterator usages in java.desktop
  • ... and 26 more: https://git.openjdk.java.net/jdk/compare/124f82377ba93359bc59118ee315ba194080fa92...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready label Oct 13, 2021
Copy link
Member

@irisclark irisclark left a comment

Associated CSR also Reviewed.

naotoj
naotoj approved these changes Oct 13, 2021
@LanceAndersen
Copy link
Contributor Author

@LanceAndersen LanceAndersen commented Oct 13, 2021

/csr

@openjdk openjdk bot added the csr label Oct 13, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Oct 13, 2021

@LanceAndersen this pull request will not be integrated until the CSR request JDK-8275164 for issue JDK-8275163 has been approved.

@openjdk openjdk bot added ready and removed ready csr labels Oct 13, 2021
@LanceAndersen
Copy link
Contributor Author

@LanceAndersen LanceAndersen commented Oct 15, 2021

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Oct 15, 2021

Going to push as commit 831802d.
Since your change was applied there have been 37 commits pushed to the master branch:

  • ad9e234: 8275145: file.encoding system property has an incorrect value on Windows
  • f178185: 8275249: Suppress warnings on non-serializable array component types in jdk.jlink
  • ee64ce9: 8274937: Revert the timeout setting for DynamicLoaderConstraintsTest
  • 8c4da9c: 8275013: Improve discussion of serialization method declarations in java.io.Object{Input, Output}Stream
  • da8da3a: 8269698: Specification for methods of java.awt.im.InputContext should mention that they do nothing
  • 8e02064: 8049520: FileCredentialsCache loads cache once and is never refreshed
  • 172aed1: 8274338: com/sun/jdi/RedefineCrossEvent.java failed "assert(m != __null) failed: NULL mirror"
  • ced7909: 8275286: Check current thread when calling JRT methods that expect it
  • c0f3e1d: 8271071: accessibility of a table on macOS lacks cell navigation
  • 4cb7124: 8262912: ciReplay: replay does not simulate unresolved classes
  • ... and 27 more: https://git.openjdk.java.net/jdk/compare/124f82377ba93359bc59118ee315ba194080fa92...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Oct 15, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Oct 15, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Oct 15, 2021

@LanceAndersen Pushed as commit 831802d.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs integrated
4 participants