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

8261301: StringWriter.flush() is NOOP but documentation does not indicate it #3383

Closed
wants to merge 1 commit into from

Conversation

bplb
Copy link
Member

@bplb bplb commented Apr 7, 2021

The specification of the method flush() in the java.io classes CharArrayWriter and StringWriter is not explicit about the fact that the method has no effect. This request proposes to add to the specification of each flush() method the sentence

The {@code flush} method of {@code <ClassName/>} does nothing.

The corresponding CSR is JDK-8264867.


Progress

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

Issue

  • JDK-8261301: StringWriter.flush() is NOOP but documentation does not indicate it

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 3383

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 7, 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 the rfr Pull request is ready for review label Apr 7, 2021
@openjdk
Copy link

openjdk bot commented Apr 7, 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 Apr 7, 2021
@mlbridge
Copy link

mlbridge bot commented Apr 7, 2021

Webrevs

@bplb
Copy link
Member Author

bplb commented Apr 7, 2021

/csr

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Apr 7, 2021
@openjdk
Copy link

openjdk bot commented Apr 7, 2021

@bplb this pull request will not be integrated until the CSR request JDK-8264867 for issue JDK-8261301 has been approved.

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.

In the CSR, the first sentence of the Summary should be context free.
It is used standalone in other contexts to describe the change. Perhaps change to:
"Clarify the flush methods in java.io classes CharArrayWriter and StringWriter do nothing."

@bplb
Copy link
Member Author

bplb commented Apr 9, 2021

@RogerRiggs I updated the CSR as you suggested, thanks!

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

openjdk bot commented Apr 15, 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:

8261301: StringWriter.flush() is NOOP but documentation does not indicate it

Reviewed-by: naoto, rriggs

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 386 new commits pushed to the master branch:

  • e7cbeba: 8259070: Add jcmd option to dump CDS
  • 5931948: 8265246: Fix macos-Aarch64 build after JDK-8263709
  • 79bff21: 8263709: Cleanup THREAD/TRAPS/CHECK usage in JRT_ENTRY routines
  • f4c3efd: 8265192: [macos_aarch64] configure script fails if GNU uname in PATH
  • e167577: 8265078: jpackage tests on Windows leave large temp files
  • 05f851e: 8265236: ProblemList java/foreign/TestUpcall.java on macosx-aarch64
  • d1b28e7: 8265231: (fc) ReadDirect and WriteDirect tests fail after fix for JDK-8264821
  • 57f86a0: 8265235: ProblemList java/foreign/TestIntrinsics.java on macosx-aarch64
  • 4c83d24: 8058176: [mlvm] tests should not allow code cache exhaustion
  • 9406744: 8264976: Minor numeric bug in AbstractSplittableWithBrineGenerator.makeSplitsSpliterator
  • ... and 376 more: https://git.openjdk.java.net/jdk/compare/6aa28b3bdb78eb041a963d659d61e1622bc43ef8...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 Apr 15, 2021
@bplb
Copy link
Member Author

bplb commented Apr 15, 2021

/integrate

@openjdk openjdk bot closed this Apr 15, 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 Apr 15, 2021
@openjdk
Copy link

openjdk bot commented Apr 15, 2021

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

  • 0b1b5c8: 8264373: javac hangs when annotation is declared with sealed public modifier
  • c7da64a: 8265302: ProblemList runtime/logging/RedefineClasses.java on linux-x64 -Xcomp
  • 838c11f: 8265293: ProblemList java/foreign/TestDowncall.java on macosx-aarch64
  • 325eecb: 8255273: jshell crashes with UnsupportedOperationException: Should not get here.
  • e43aee5: 8262900: ToolBasicTest fails to access HTTP server it starts
  • c70589c: 8265227: Move Proc.java from security/testlibrary to test/lib
  • 7b61a42: 8265173: [test] divert spurious log output away from stream under test in ProcessBuilder Basic test
  • 4e90d74: 8048199: Replace anonymous inner classes with lambdas, where applicable, in JNDI
  • 6293299: 8264824: java/net/Inet6Address/B6206527.java doesn't close ServerSocket properly
  • 6b90715: 8265278: doc build fails after JDK-8262981
  • ... and 399 more: https://git.openjdk.java.net/jdk/compare/6aa28b3bdb78eb041a963d659d61e1622bc43ef8...master

Your commit was automatically rebased without conflicts.

Pushed as commit e89fd15.

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

@bplb bplb deleted the Writer-flush-8261301 branch April 16, 2021 17:27
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
3 participants