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

8247918: Clarify Reader.skip behavior for end of stream #2274

Closed
wants to merge 3 commits into from

Conversation

bplb
Copy link
Member

@bplb bplb commented Jan 28, 2021

Please review this clarification of the specification of the method skip(long) in java.io.Reader and its subclasses. Specifically, the behavior of the method is made clear for the case when the Reader is already at the end of its stream when the method is invoked. A corresponding CSR will be filed. Also, the change includes an update to an existing test in order to verify that the specification change reflects actual behavior.


Progress

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

Issue

  • JDK-8247918: Clarify Reader.skip behavior for end of stream

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/2274/head:pull/2274
$ git checkout pull/2274

@bplb
Copy link
Member Author

bplb commented Jan 28, 2021

/csr

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 28, 2021

👋 Welcome back bpb! 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 added rfr Pull request is ready for review csr Pull request needs approved CSR before integration labels Jan 28, 2021
@openjdk
Copy link

openjdk bot commented Jan 28, 2021

@bplb has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@bplb please create a CSR request and add link to it in JDK-8247918. This pull request cannot be integrated until the CSR request is approved.

@openjdk
Copy link

openjdk bot commented Jan 28, 2021

@bplb 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 core-libs-dev@openjdk.org label Jan 28, 2021
@mlbridge
Copy link

mlbridge bot commented Jan 28, 2021

Webrevs

@bplb
Copy link
Member Author

bplb commented Feb 8, 2021

ping

Copy link
Contributor

@RogerRiggs RogerRiggs left a comment

Choose a reason for hiding this comment

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

The use of @ inheritdoc causes some unexpected changes in the javadoc, dropping the skip method from several classes.

@liach
Copy link
Member

liach commented Feb 12, 2021

I personally suggest moving this clarification into a separate paragraph as opposed to appending it to the first sentence.

@mlbridge
Copy link

mlbridge bot commented Feb 12, 2021

Mailing list message from Brian Burkhalter on core-libs-dev:

I would be all right with that.

@openjdk openjdk bot removed the csr Pull request needs approved CSR before integration label Feb 19, 2021
@openjdk
Copy link

openjdk bot commented Feb 19, 2021

@bplb 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:

8247918: Clarify Reader.skip behavior for end of stream

Reviewed-by: rriggs, 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 810 new commits pushed to the master branch:

  • 8a1c712: 8261728: SimpleDateFormat should link to DateTimeFormatter
  • 851b2e3: 6245663: (spec) File.renameTo(File) changes the file-system object, not the File instance
  • c4f17a3: 8257925: enable more support for nested inline tags
  • 433096a: 8261744: Implement CharsetDecoder ASCII and latin-1 fast-paths
  • efbaede: 8262018: Wrong format in SAP copyright header of OsVersionTest
  • 55463b0: 8261984: Shenandoah: Remove unused ShenandoahPushWorkerQueuesScope class
  • a180a38: 8260694: (fc) Clarify FileChannel.transferFrom to better describe "no bytes available" case
  • 1b0c36b: 8261649: AArch64: Optimize LSE atomics in C++ code
  • 61820b7: 8259984: IGV: Crash when drawing control flow before GCM
  • 7e2c909: 8260485: Simplify and unify handler vectors in Posix signal code
  • ... and 800 more: https://git.openjdk.java.net/jdk/compare/7b05439dcc5a8c46bbbd7e2c820c020aacd3f08f...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 Pull request is ready to be integrated label Feb 19, 2021
@bplb
Copy link
Member Author

bplb commented Feb 19, 2021

/integrate

@openjdk openjdk bot closed this Feb 19, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Feb 19, 2021
@openjdk
Copy link

openjdk bot commented Feb 19, 2021

@bplb Since your change was applied there have been 810 commits pushed to the master branch:

  • 8a1c712: 8261728: SimpleDateFormat should link to DateTimeFormatter
  • 851b2e3: 6245663: (spec) File.renameTo(File) changes the file-system object, not the File instance
  • c4f17a3: 8257925: enable more support for nested inline tags
  • 433096a: 8261744: Implement CharsetDecoder ASCII and latin-1 fast-paths
  • efbaede: 8262018: Wrong format in SAP copyright header of OsVersionTest
  • 55463b0: 8261984: Shenandoah: Remove unused ShenandoahPushWorkerQueuesScope class
  • a180a38: 8260694: (fc) Clarify FileChannel.transferFrom to better describe "no bytes available" case
  • 1b0c36b: 8261649: AArch64: Optimize LSE atomics in C++ code
  • 61820b7: 8259984: IGV: Crash when drawing control flow before GCM
  • 7e2c909: 8260485: Simplify and unify handler vectors in Posix signal code
  • ... and 800 more: https://git.openjdk.java.net/jdk/compare/7b05439dcc5a8c46bbbd7e2c820c020aacd3f08f...master

Your commit was automatically rebased without conflicts.

Pushed as commit 7ffa148.

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

@bplb bplb deleted the 8247918-Reader-skip-at-EOL branch February 19, 2021 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
4 participants