8247918: Clarify Reader.skip behavior for end of stream

[bplb]

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

• Roger Riggs (@RogerRiggs - Reviewer)
• Naoto Sato (@naotoj - Reviewer)

Download

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

[bplb]

/csr

[bridgekeeper]

👋 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]

@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]

@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.

[mlbridge]

Webrevs

• 02: Full - Incremental (a33245d)
• 01: Full - Incremental (2a2ceb4)
• 00: Full (0ebed6e)

[bplb]

ping

[RogerRiggs]

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

[liach]

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

[mlbridge]

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

I would be all right with that.

[openjdk]

@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.

[bplb]

/integrate

[openjdk]

@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.