JDK-8310571: Use inline @return tag on java.util.Objects #14608

jddarcy · 2023-06-22T00:19:03Z

Small cleanup, minor differences in the wording of portions of toString(Object, String), nonNull(Object), requireNonNullElse, and requireNonNullElseGet.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8310571: Use inline @return tag on java.util.Objects (Enhancement - P4)

Reviewers

Stuart Marks (@stuart-marks - Reviewer) ⚠️ Review applies to 026b3caf

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/14608/head:pull/14608
$ git checkout pull/14608

Update a local copy of the PR:
$ git checkout pull/14608
$ git pull https://git.openjdk.org/jdk.git pull/14608/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14608

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/14608.diff

Webrev

Link to Webrev Comment

bridgekeeper · 2023-06-22T00:20:08Z

👋 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 · 2023-06-22T00:21:40Z

@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 · 2023-06-22T00:25:09Z

Webrevs

stuart-marks

Looks good. I had to refresh my understanding of the exact behavior of the inline @return tag:

https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html

(search for {@return)

It adds a leading "Returns " and a trailing "." to the block's text, and inserts a "Returns" section in the proper place. This seems oddly specific, but it's tailored for this exact use case. Anyway, good cleanup.

openjdk · 2023-06-22T00:54:06Z

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

8310571: Use inline @return tag on java.util.Objects

Reviewed-by: smarks

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:

dad7bd9: 8310234: Refactor Locale tests to use JUnit
69f3114: 8310676: add note about unnamed module to Elements.getAllModuleElements
bfcca5e: 8310494: Do not include constantPool.hpp from instanceKlass.hpp

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.

pavelrappo · 2023-06-22T10:36:50Z

I can see that Objects.hash(Object...) was not changed in this PR. Although I think I can see why, I wonder if any distinctions between "Generates" and "Returns" are not important in that context:

   /**
    * Generates a hash code for a sequence of input values. The hash
...
    * @return a hash value of the sequence of input values
...
    */
    public static int hash(Object... values) {

pavelrappo

Thanks for doing this, Joe. It seems that I have made multiple comments on the same issue. It makes me wonder if that isn't an issue at all, but is a deliberate choice made in this PR.

pavelrappo · 2023-06-22T10:44:42Z

src/java.base/share/classes/java/util/Objects.java

+     * {@return the result of calling {@code toString} on the first
     * argument if the first argument is not {@code null} and returns
-     * the second argument otherwise.
+     * the second argument otherwise}


This "returns" in "and returns" feels non-DRY and brittle. We enclosed that word in {@return} already. Maybe we could use the wording from the original @return to avoid the verb altogether?

This is of course, a personal opinion.

pavelrappo · 2023-06-22T11:00:31Z

src/java.base/share/classes/java/util/Objects.java

    /**
-     * Returns {@code true} if the provided reference is {@code null} otherwise
-     * returns {@code false}.
+     * {@return {@code true} if the provided reference is {@code


See my previous comment on the "returns" verb in the doc comment for toString(Object, String). Here (IMO), you picked the better of the two options.

pavelrappo · 2023-06-22T11:02:54Z

src/java.base/share/classes/java/util/Objects.java

+     * {@return the first argument if it is non-{@code null} and
+     * otherwise returns the non-{@code null} second argument}


Same comment for "returns".

pavelrappo · 2023-06-22T11:04:00Z

src/java.base/share/classes/java/util/Objects.java

+     * {@return the first argument if it is non-{@code null} and otherwise
+     * returns the non-{@code null} value of {@code supplier.get()}}


jddarcy · 2023-06-23T22:54:28Z

/integrate

openjdk · 2023-06-23T22:55:10Z

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

dad7bd9: 8310234: Refactor Locale tests to use JUnit
69f3114: 8310676: add note about unnamed module to Elements.getAllModuleElements
bfcca5e: 8310494: Do not include constantPool.hpp from instanceKlass.hpp

Your commit was automatically rebased without conflicts.

openjdk · 2023-06-23T22:55:17Z

@jddarcy Pushed as commit 0db63ec.

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

JDK-8310571: Use inline @return tag on java.util.Objects

026b3ca

openjdk bot added the rfr Pull request is ready for review label Jun 22, 2023

openjdk bot added the core-libs core-libs-dev@openjdk.org label Jun 22, 2023

stuart-marks approved these changes Jun 22, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jun 22, 2023

pavelrappo mentioned this pull request Jun 22, 2023

JDK-8310453: Update javadoc of java.lang.Object #14567

Closed

3 tasks

pavelrappo reviewed Jun 22, 2023

View reviewed changes

jddarcy added 4 commits June 22, 2023 10:05

Merge branch 'master' into JDK-8310571

7d70f9a

Merge branch 'master' into JDK-8310571

54f91e8

Respond to review feedback.

d97eb7a

Make sure there is not an unwanted word break around "non-null".

7fae1b7

openjdk bot added the integrated Pull request has been integrated label Jun 23, 2023

openjdk bot closed this Jun 23, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 23, 2023

jddarcy deleted the JDK-8310571 branch October 17, 2024 16:54

		* {@return the first argument if it is non-{@code null} and
		* otherwise returns the non-{@code null} second argument}

		* {@return the first argument if it is non-{@code null} and otherwise
		* returns the non-{@code null} value of {@code supplier.get()}}

JDK-8310571: Use inline @return tag on java.util.Objects #14608

JDK-8310571: Use inline @return tag on java.util.Objects #14608

Uh oh!

Conversation

jddarcy commented Jun 22, 2023 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Jun 22, 2023

Uh oh!

openjdk bot commented Jun 22, 2023

Uh oh!

mlbridge bot commented Jun 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

stuart-marks left a comment

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Jun 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pavelrappo commented Jun 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pavelrappo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pavelrappo Jun 22, 2023

Choose a reason for hiding this comment

Uh oh!

pavelrappo Jun 22, 2023

Choose a reason for hiding this comment

Uh oh!

pavelrappo Jun 22, 2023

Choose a reason for hiding this comment

Uh oh!

pavelrappo Jun 22, 2023

Choose a reason for hiding this comment

Uh oh!

jddarcy commented Jun 23, 2023

Uh oh!

openjdk bot commented Jun 23, 2023

Uh oh!

openjdk bot commented Jun 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

jddarcy commented Jun 22, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jun 22, 2023 •

edited

Loading

openjdk bot commented Jun 22, 2023 •

edited

Loading

pavelrappo commented Jun 22, 2023 •

edited

Loading

pavelrappo left a comment •

edited

Loading