8323746: Add PathElement hashCode and equals #17651

minborg · 2024-01-31T13:04:07Z

This PR proposes to implement hashCode() and equals() methods for implementations of PathElement.

In doing so, the previous PathElementImpl was removed and replaced in favor of distinct record implementations, each reflecting its own path element selection type. This also allowed the PathKind to be removed as this piece of information is now carried in the sealed type hierarchy.

It is worth noting, the implementations resides in the jdk.internal package and consequently, they are not exposed to clients. So, we could use pattern matching (for example) internally but not in client code.

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-8323746: Add PathElement hashCode and equals (Enhancement - P4)

Reviewers

Maurizio Cimadamore (@mcimadamore - Reviewer) ⚠️ Review applies to 5685e31a

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17651

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-01-31T13:04:48Z

👋 Welcome back pminborg! 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 · 2024-01-31T13:06:04Z

@minborg 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 · 2024-01-31T13:10:09Z

Webrevs

mcimadamore · 2024-01-31T18:21:09Z

src/java.base/share/classes/jdk/internal/foreign/LayoutPath.java

+
+    }
+
+    public static final class SequenceElement


Why are these not empty records?

I had that in the beginning but converted them to regular classes as they do not have any record components. But maybe it is better to make them all records for consistency?

I think so, even less code :-)

openjdk · 2024-02-03T09:08:39Z

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

8323746: Add PathElement hashCode and equals

Reviewed-by: mcimadamore

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

43089bf: 8325399: Add tests for virtual threads doing Selector operations
d109903: 8325028: (ch) Pipe channels should lazily set socket to non-blocking mode on first use by virtual thread
1fb9e3d: 8325304: Several classes in java.util.jar and java.util.zip don't specify the behaviour for null arguments
9cccf05: 8325367: Rename nsk_list.h
be7cc1c: 8323681: SA PointerFinder code should support G1
fbd15b2: 8325189: Enable this-escape javac warning in java.base
299a8ee: 8325302: Files.move(REPLACE_EXISTING) throws NoSuchFileException on deleted target
3a1f4d0: 8325268: Add policy statement to langtools makefiles concerning warnings
18e24d0: 8325109: Sort method modifiers in canonical order
a3a2b1f: 8324881: ObjectSynchronizer::inflate(Thread* current...) is invoked for non-current thread
... and 90 more: https://git.openjdk.org/jdk/compare/ec56c72b5160ea20ed123c6e1e3379b6b13ecb7d...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.

ExE-Boss

These can now be removed:

ExE-Boss · 2024-02-03T11:28:33Z

src/java.base/share/classes/jdk/internal/foreign/LayoutPath.java

+        @Override
+        public int hashCode() {
+            return 31;
+        }



Suggested change

@Override

public int hashCode() {

return 31;

}

ExE-Boss · 2024-02-03T11:28:51Z

src/java.base/share/classes/jdk/internal/foreign/LayoutPath.java

+        @Override
+        public int hashCode() {
+            return 63;
        }



Suggested change

@Override

public int hashCode() {

return 63;

}

So, a record with no component will have a hashCode() of zero. I didn't want the two singleton variants to have the same hash code. I've added a test for this and will remove one of the overrides.

minborg · 2024-02-08T10:53:21Z

/integrate

openjdk · 2024-02-08T10:54:12Z

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

917838e: 8325150: (tz) Update Timezone Data to 2024a
43089bf: 8325399: Add tests for virtual threads doing Selector operations
d109903: 8325028: (ch) Pipe channels should lazily set socket to non-blocking mode on first use by virtual thread
1fb9e3d: 8325304: Several classes in java.util.jar and java.util.zip don't specify the behaviour for null arguments
9cccf05: 8325367: Rename nsk_list.h
be7cc1c: 8323681: SA PointerFinder code should support G1
fbd15b2: 8325189: Enable this-escape javac warning in java.base
299a8ee: 8325302: Files.move(REPLACE_EXISTING) throws NoSuchFileException on deleted target
3a1f4d0: 8325268: Add policy statement to langtools makefiles concerning warnings
18e24d0: 8325109: Sort method modifiers in canonical order
... and 91 more: https://git.openjdk.org/jdk/compare/ec56c72b5160ea20ed123c6e1e3379b6b13ecb7d...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-02-08T10:54:18Z

@minborg Pushed as commit b58d73b.

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

minborg added 2 commits January 31, 2024 13:34

Rewrite PathElement implementations using records

263ca81

Turn some record classes into regular classes

af7fa99

openjdk bot added the rfr Pull request is ready for review label Jan 31, 2024

openjdk bot added the core-libs core-libs-dev@openjdk.org label Jan 31, 2024

mcimadamore reviewed Jan 31, 2024

View reviewed changes

Make all PathElements records

5685e31

mcimadamore approved these changes Feb 3, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Feb 3, 2024

ExE-Boss reviewed Feb 3, 2024

View reviewed changes

Rework hashCode implementations and add a test for hash codes

d6da622

openjdk bot added the integrated Pull request has been integrated label Feb 8, 2024

openjdk bot closed this Feb 8, 2024

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Feb 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8323746: Add PathElement hashCode and equals #17651

8323746: Add PathElement hashCode and equals #17651

minborg commented Jan 31, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jan 31, 2024

openjdk bot commented Jan 31, 2024

mlbridge bot commented Jan 31, 2024 •

edited

Loading

mcimadamore Jan 31, 2024

minborg Feb 1, 2024 •

edited

Loading

mcimadamore Feb 1, 2024

openjdk bot commented Feb 3, 2024 •

edited

Loading

ExE-Boss left a comment

ExE-Boss Feb 3, 2024

ExE-Boss Feb 3, 2024

minborg Feb 8, 2024

minborg commented Feb 8, 2024

openjdk bot commented Feb 8, 2024

openjdk bot commented Feb 8, 2024

8323746: Add PathElement hashCode and equals #17651

8323746: Add PathElement hashCode and equals #17651

Conversation

minborg commented Jan 31, 2024 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Jan 31, 2024

openjdk bot commented Jan 31, 2024

mlbridge bot commented Jan 31, 2024 • edited Loading

Webrevs

mcimadamore Jan 31, 2024

Choose a reason for hiding this comment

minborg Feb 1, 2024 • edited Loading

Choose a reason for hiding this comment

mcimadamore Feb 1, 2024

Choose a reason for hiding this comment

openjdk bot commented Feb 3, 2024 • edited Loading

ExE-Boss left a comment

Choose a reason for hiding this comment

ExE-Boss Feb 3, 2024

Choose a reason for hiding this comment

ExE-Boss Feb 3, 2024

Choose a reason for hiding this comment

minborg Feb 8, 2024

Choose a reason for hiding this comment

minborg commented Feb 8, 2024

openjdk bot commented Feb 8, 2024

openjdk bot commented Feb 8, 2024

minborg commented Jan 31, 2024 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 31, 2024 •

edited

Loading

minborg Feb 1, 2024 •

edited

Loading

openjdk bot commented Feb 3, 2024 •

edited

Loading