8273513: Make java.io.FilterInputStream specification more precise about overrides #5426

bplb · 2021-09-08T22:00:53Z

Modify the class level specification of java.io.FilterInputStream to be more exact about java.io.InputStream methods that it overrides.

Progress

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

Issue

JDK-8273513: Make java.io.FilterInputStream specification more precise about overrides

Reviewers

Daniel Fuchs (@dfuch - Reviewer) ⚠️ Review applies to 07dbe2f
Naoto Sato (@naotoj - Reviewer) ⚠️ Review applies to 96f5ffc

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5426

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

Using diff file

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

…out overrides

bplb · 2021-09-08T22:02:37Z

Some other incidental modifications are made in passing, principally adding @Override annotations and putting statements like This method does X in @implSpec blocks.

bridgekeeper · 2021-09-08T22:03:26Z

👋 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 · 2021-09-08T22:06:19Z

@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 · 2021-09-08T22:11:12Z

Webrevs

bplb · 2021-09-08T22:13:56Z

/csr

openjdk · 2021-09-08T22:14:47Z

@bplb has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@bplb please create a CSR request for issue JDK-8273513. This pull request cannot be integrated until the CSR request is approved.

bplb · 2021-09-09T00:59:36Z

CSR filed: JDK-8273517.

dfuch

LGTM. The use of synchronized on mark() and reset() is strange. But I guess that should be for another day...

naotoj

LGTM.

naotoj · 2021-09-10T00:39:57Z

src/java.base/share/classes/java/io/FilterInputStream.java

@@ -86,7 +83,8 @@ public int read() throws IOException {
     * Reads up to {@code b.length} bytes of data from this
     * input stream into an array of bytes. This method blocks until some
     * input is available.
-     * <p>
+     *
+     * @implSpec
     * This method simply performs the call
     * {@code read(b, 0, b.length)} and returns
     * the  result. It is important that it does


Preexisting: an extra space before "result."

openjdk · 2021-09-13T01:50:41Z

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

8273513: Make java.io.FilterInputStream specification more precise about overrides

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

2ee1f96: 8273484: Cleanup unnecessary null comparison before instanceof check in java.naming
f189dff: 8273595: tools/jpackage tests do not work on apt-based Linux distros like Debian
922e86f: 8273522: Rename test property vm.cds.archived.java.heap to vm.cds.write.archived.java.heap
f42b927: 8273609: Fix trivial doc typos in the compiler area
e4cd209: 8273611: Remove unused ProfilePrint_lock
f690a01: 8273278: Support XSLT on GraalVM Native Image--deterministic bytecode generation in XSLT
5e1df2c: 8273162: AbstractSplittableWithBrineGenerator does not create a random salt
d4177a9: 8273351: bad tag in jdk.random module-info.java
ec9d1be: 8273194: Document the two possible cases when Lookup::ensureInitialized returns
81d2ace: 8273369: Computing micros between two instants unexpectedly overflows for some cases
... and 35 more: https://git.openjdk.java.net/jdk/compare/a5e4def526697d88ff31a5fdb41d823b899372f2...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 · 2021-09-13T17:48:16Z

/integrate

openjdk · 2021-09-13T17:50:20Z

Going to push as commit 6cf5079.
Since your change was applied there have been 54 commits pushed to the master branch:

b4b1210: 8273616: Fix trivial doc typos in the java.base module
7c26ddb: 8195809: [TESTBUG] jps and jcmd -l support for containers is not tested
4cfa230: 8273259: Character.getName doesn't follow Unicode spec for ideographs
f9b2507: 8271834: TestStringDeduplicationAgeThreshold intermittent failures on Shenandoah
261cb44: 8273629: compiler/uncommontrap/TestDeoptOOM.java fails with release VMs
b0d0497: 8273584: TypeElement.getSuperclass crashes for a record TypeElement when j.l.Record is not available
4efcd20: 8273478: [macos11] JTabbedPane selected and pressed tab is not legible
a73c06d: 8273021: C2: Improve Add and Xor ideal optimizations
9f86082: 8273610: LogTestFixture::restore_config() should not restore options
2ee1f96: 8273484: Cleanup unnecessary null comparison before instanceof check in java.naming
... and 44 more: https://git.openjdk.java.net/jdk/compare/a5e4def526697d88ff31a5fdb41d823b899372f2...master

Your commit was automatically rebased without conflicts.

openjdk · 2021-09-13T17:50:34Z

@bplb Pushed as commit 6cf5079.

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

8273513: Make java.io.FilterInputStream specification more precise ab…

07dbe2f

…out overrides

openjdk bot added the rfr Pull request is ready for review label Sep 8, 2021

openjdk bot added the core-libs core-libs-dev@openjdk.org label Sep 8, 2021

openjdk bot added the csr Pull request needs approved CSR before integration label Sep 8, 2021

dfuch approved these changes Sep 9, 2021

View reviewed changes

8273513: Change key to select as suggested in CSR comment

96f5ffc

naotoj approved these changes Sep 10, 2021

View reviewed changes

8273513: Remove an extra space

bf2896a

openjdk bot removed the csr Pull request needs approved CSR before integration label Sep 13, 2021

openjdk bot added the ready Pull request is ready to be integrated label Sep 13, 2021

openjdk bot closed this Sep 13, 2021

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 Sep 13, 2021

bplb deleted the FilterInputStream-spec-8273513 branch September 13, 2021 17:50

8273513: Make java.io.FilterInputStream specification more precise about overrides #5426

8273513: Make java.io.FilterInputStream specification more precise about overrides #5426

bplb commented Sep 8, 2021 •

edited by openjdk bot

bplb commented Sep 8, 2021

bridgekeeper bot commented Sep 8, 2021

openjdk bot commented Sep 8, 2021

mlbridge bot commented Sep 8, 2021 •

edited

bplb commented Sep 8, 2021

openjdk bot commented Sep 8, 2021

bplb commented Sep 9, 2021

dfuch left a comment

naotoj left a comment

naotoj Sep 10, 2021

openjdk bot commented Sep 13, 2021 •

edited

bplb commented Sep 13, 2021

openjdk bot commented Sep 13, 2021

openjdk bot commented Sep 13, 2021

8273513: Make java.io.FilterInputStream specification more precise about overrides #5426

8273513: Make java.io.FilterInputStream specification more precise about overrides #5426

Conversation

bplb commented Sep 8, 2021 • edited by openjdk bot

Progress

Issue

Reviewers

Reviewing

bplb commented Sep 8, 2021

bridgekeeper bot commented Sep 8, 2021

openjdk bot commented Sep 8, 2021

mlbridge bot commented Sep 8, 2021 • edited

Webrevs

bplb commented Sep 8, 2021

openjdk bot commented Sep 8, 2021

bplb commented Sep 9, 2021

dfuch left a comment

Choose a reason for hiding this comment

naotoj left a comment

Choose a reason for hiding this comment

naotoj Sep 10, 2021

Choose a reason for hiding this comment

openjdk bot commented Sep 13, 2021 • edited

bplb commented Sep 13, 2021

openjdk bot commented Sep 13, 2021

openjdk bot commented Sep 13, 2021

bplb commented Sep 8, 2021 •

edited by openjdk bot

mlbridge bot commented Sep 8, 2021 •

edited

openjdk bot commented Sep 13, 2021 •

edited