JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException #7711

jddarcy · 2022-03-05T02:57:47Z

Occasionally in core-libs we've discussed whether or not to do a pass over the exception classes and proactively add any of four missing convention constructors per java.lang.Throwable (no-arg, string, cause, cause and string). Last time this came up, we decided a wide-scale effort wasn't worthwhile.

Prompted by some other recent work, I decided to take a quick look at the dual-approach: grep for calls to initCause in java.base and seeing which exception classes repeated were initCaused. Those exception classes are good candidates for cause-taking constructors.

Two such exception classes area InvalidObjectException and InvalidClassException, along with their superclass ObjectStreamException.

Please also review the CSR: https://bugs.openjdk.java.net/browse/JDK-8282697

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed
Change requires a CSR request to be approved

Issues

JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException
JDK-8282697: Add constructors take a cause to InvalidObjectException and InvalidClassException (CSR)

Reviewers

Lance Andersen (@LanceAndersen - Reviewer) ⚠️ Review applies to 80f97dc

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 7711

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

Using diff file

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

…and InvalidClassException

jddarcy · 2022-03-05T02:58:12Z

/csr

bridgekeeper · 2022-03-05T02:59:00Z

👋 Welcome back darcy! 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 · 2022-03-05T03:01:18Z

@jddarcy this pull request will not be integrated until the CSR request JDK-8282697 for issue JDK-8282696 has been approved.

openjdk · 2022-03-05T03:05:50Z

@jddarcy 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 · 2022-03-05T03:09:18Z

Webrevs

RogerRiggs · 2022-03-05T03:17:48Z

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

+     * @since 19
+     */
+    public  InvalidObjectException(String reason, Throwable cause) {
+        super(reason);


Should this be: super(reason, cause)?

Yes; good catch -- will fix in the next push. Thanks.

RogerRiggs · 2022-03-05T03:17:48Z

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

-                    cl).initCause(ex);
+                throw new InvalidObjectException("enum constant " +
+                                                 name + " does not exist in " +
+                                                 cl, ex);


Can this be reflowed to be on two lines instead of 3? Your call.

openjdk · 2022-03-05T16:51:11Z

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

8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException

Reviewed-by: lancea

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

6fc73f7: 8282620: G1/Parallel: Constify is_in_young() predicates
894ffb0: 8282713: Invalid copyright notice in new test added by JDK-8275715
415bf44: 8275715: D3D pipeline processes multiple PaintEvent at initial drawing

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

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

turbanoff · 2022-03-06T13:32:32Z

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

@@ -48,4 +48,18 @@
    public  InvalidObjectException(String reason) {


Suggested change

public InvalidObjectException(String reason) {

public InvalidObjectException(String reason) {

jddarcy · 2022-03-07T14:46:24Z

/integrate

openjdk · 2022-03-07T14:48:06Z

Going to push as commit 104e3cb.
Since your change was applied there have been 3 commits pushed to the master branch:

6fc73f7: 8282620: G1/Parallel: Constify is_in_young() predicates
894ffb0: 8282713: Invalid copyright notice in new test added by JDK-8275715
415bf44: 8275715: D3D pipeline processes multiple PaintEvent at initial drawing

Your commit was automatically rebased without conflicts.

openjdk · 2022-03-07T14:48:27Z

@jddarcy Pushed as commit 104e3cb.

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

JDK-8282696: Add constructors take a cause to InvalidObjectException …

afc1d01

…and InvalidClassException

openjdk bot added rfr Pull request is ready for review csr Pull request needs approved CSR before integration labels Mar 5, 2022

openjdk bot added the core-libs core-libs-dev@openjdk.org label Mar 5, 2022

Retrofit another location.

7ff24c2

RogerRiggs suggested changes Mar 5, 2022

View changes

Respond to review feedback.

2b2219e

openjdk bot removed the csr Pull request needs approved CSR before integration label Mar 5, 2022

LanceAndersen approved these changes Mar 5, 2022

View changes

openjdk bot added the ready Pull request is ready to be integrated label Mar 5, 2022

turbanoff reviewed Mar 5, 2022

View changes

src/java.base/share/classes/java/io/InvalidObjectException.java Outdated Show resolved Hide resolved

turbanoff reviewed Mar 6, 2022

View changes

Fix whitespace.

80f97dc

LanceAndersen approved these changes Mar 6, 2022

View changes

jddarcy added 4 commits March 6, 2022 12:09

Fix more whitespace.

5a29e7c

Merge branch 'master' into JDK-8282696

948269c

Add regression tests.

2de370f

Reflow per review comments.

2aeb7f0

jddarcy changed the title ~~JDK-8282696: Add constructors take a cause to InvalidObjectException and InvalidClassException~~ JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException Mar 7, 2022

openjdk bot removed the ready Pull request is ready to be integrated label Mar 7, 2022

openjdk bot added the ready Pull request is ready to be integrated label Mar 7, 2022

openjdk bot added the integrated Pull request has been integrated label Mar 7, 2022

openjdk bot closed this Mar 7, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 7, 2022

JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException #7711

JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException #7711

jddarcy commented Mar 5, 2022 •

edited by openjdk bot

jddarcy commented Mar 5, 2022

bridgekeeper bot commented Mar 5, 2022

openjdk bot commented Mar 5, 2022

openjdk bot commented Mar 5, 2022

mlbridge bot commented Mar 5, 2022 •

edited

RogerRiggs Mar 5, 2022

jddarcy Mar 5, 2022

RogerRiggs Mar 5, 2022

openjdk bot commented Mar 5, 2022 •

edited

turbanoff Mar 6, 2022

jddarcy commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

		@@ -48,4 +48,18 @@
		public InvalidObjectException(String reason) {

JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException #7711

JDK-8282696: Add constructors taking a cause to InvalidObjectException and InvalidClassException #7711

Conversation

jddarcy commented Mar 5, 2022 • edited by openjdk bot

Progress

Issues

Reviewers

Reviewing

jddarcy commented Mar 5, 2022

bridgekeeper bot commented Mar 5, 2022

openjdk bot commented Mar 5, 2022

openjdk bot commented Mar 5, 2022

mlbridge bot commented Mar 5, 2022 • edited

Webrevs

RogerRiggs Mar 5, 2022

Choose a reason for hiding this comment

jddarcy Mar 5, 2022

Choose a reason for hiding this comment

RogerRiggs Mar 5, 2022

Choose a reason for hiding this comment

openjdk bot commented Mar 5, 2022 • edited

turbanoff Mar 6, 2022

Choose a reason for hiding this comment

jddarcy commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

jddarcy commented Mar 5, 2022 •

edited by openjdk bot

mlbridge bot commented Mar 5, 2022 •

edited

openjdk bot commented Mar 5, 2022 •

edited