8268469: Update java.time to use switch expressions #4433

pconcannon · 2021-06-09T15:41:59Z

Hi,

Could someone please review my code for updating the code in the java.time packages to make use of the switch expressions?

Kind regards,
Patrick

Progress

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

Issue

JDK-8268469: Update java.time to use switch expressions

Reviewers

Lance Andersen (@LanceAndersen - Reviewer) ⚠️ Review applies to e6d76af
Naoto Sato (@naotoj - Reviewer) ⚠️ Review applies to 24ae9e5
Daniel Fuchs (@dfuch - Reviewer) ⚠️ Review applies to 24ae9e5
Iris Clark (@irisclark - Reviewer) ⚠️ Review applies to 24ae9e5
Chris Hegarty (@ChrisHegarty - Reviewer) ⚠️ Review applies to 24ae9e5

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4433

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

Using diff file

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

bridgekeeper · 2021-06-09T15:42:33Z

👋 Welcome back pconcannon! 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-06-09T15:45:22Z

@pconcannon The following labels will be automatically applied to this pull request:

core-libs
i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2021-06-09T15:49:24Z

Webrevs

LanceAndersen

Updates look good Patrick

openjdk · 2021-06-09T16:15:09Z

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

8268469: Update java.time to use switch expressions

Reviewed-by: lancea, naoto, dfuchs, iris, chegar

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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.

naotoj

Looks good overall. Some misplaced comments. Also, copyright years should be updated.

src/java.base/share/classes/java/time/LocalDateTime.java

src/java.base/share/classes/java/time/chrono/ChronoLocalDateTimeImpl.java

src/java.base/share/classes/java/time/format/SignStyle.java

src/java.base/share/classes/java/time/Month.java

src/java.base/share/classes/java/time/chrono/ThaiBuddhistDate.java

src/java.base/share/classes/java/time/format/DateTimeFormatterBuilder.java

jodastephen

My biggest comment is the spaces used to align, which I strongly object to. I agree with @dfuch comments too.

src/java.base/share/classes/java/time/LocalDate.java

src/java.base/share/classes/java/time/chrono/ThaiBuddhistDate.java

src/java.base/share/classes/java/time/format/SignStyle.java

src/java.base/share/classes/java/time/LocalDate.java

jodastephen · 2021-06-16T10:59:46Z

src/java.base/share/classes/java/time/LocalDateTime.java

-            }
-            return with(date.plus(amountToAdd, unit), time);
+            return switch (chronoUnit) {
+                case NANOS     -> plusNanos(amountToAdd);


Still has unnecessary alignment

There are lots of cases in the PR where -> is still aligned. I'd like to see all of them unaligned.

jodastephen · 2021-06-16T10:59:59Z

src/java.base/share/classes/java/time/Month.java

-                return 335 + leap;
-        }
+        return switch (this) {
+            case JANUARY   -> 1;


Unnecessary alignment

The vertical alignment improves readability in these short-line cases. Removing the spaces before the arrows will make it a little harder to discern the difference between the cases.

It is your codebase, not mine, so it is up to you. Aligning things by column is generally frowned on in most style guides because it handles refactoring poorly, resulting in lots of needless change (or people forgetting to realign things - I had to deal with a rogue aligned Javadoc signature today in a PR where exactly that had happened). I also don't see how you write a style guide rule for when these should be aligned and when they should not.

Anyway, this PR isn't really the right place for this discussion - I'm not blocking the PR on this basis (and I'm not an official Reviewer anyway).

I have a slight preference for the aligned version in the cases where the lines are short and the number of spaces used for padding is not unreasonable. I find the code gains in readability in these cases. In the case where the lines are long - I agree with Stephen that the alignment doesn't bring much readability - and sometime it may even be detrimental as it makes long lines longer. Stephen, would that be an acceptable compromise?

Its certainly a reasonable position to take (ie. if thats what OpenJDK wants to do, its fine by me).
I'm more interested to see how you would write such a thing down in the coding standards that doesn't make the standard worthless.

src/java.base/share/classes/java/time/format/DateTimeFormatterBuilder.java

dfuch · 2021-06-17T13:56:00Z

src/java.base/share/classes/java/time/Month.java

-                return 335 + leap;
-        }
+        return switch (this) {
+            case JANUARY   -> 1;


I have a slight preference for the aligned version in the cases where the lines are short and the number of spaces used for padding is not unreasonable. I find the code gains in readability in these cases. In the case where the lines are long - I agree with Stephen that the alignment doesn't bring much readability - and sometime it may even be detrimental as it makes long lines longer. Stephen, would that be an acceptable compromise?

… logic of switch/case in LocalDate

pconcannon · 2021-06-25T15:41:24Z

/integrate

openjdk · 2021-06-25T15:42:43Z

Going to push as commit 1d16797.

openjdk · 2021-06-25T15:42:59Z

@pconcannon Pushed as commit 1d16797.

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

8268469: Update java.time to use switch expressions

e6d76af

openjdk bot added the rfr Pull request is ready for review label Jun 9, 2021

openjdk bot added core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Jun 9, 2021

LanceAndersen approved these changes Jun 9, 2021

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jun 9, 2021

naotoj reviewed Jun 9, 2021

View reviewed changes

dfuch reviewed Jun 9, 2021

View reviewed changes

src/java.base/share/classes/java/time/Month.java Show resolved Hide resolved

src/java.base/share/classes/java/time/chrono/ThaiBuddhistDate.java Outdated Show resolved Hide resolved

src/java.base/share/classes/java/time/format/DateTimeFormatterBuilder.java Outdated Show resolved Hide resolved

jodastephen reviewed Jun 9, 2021

View reviewed changes

src/java.base/share/classes/java/time/LocalDate.java Outdated Show resolved Hide resolved

src/java.base/share/classes/java/time/chrono/ThaiBuddhistDate.java Outdated Show resolved Hide resolved

src/java.base/share/classes/java/time/format/SignStyle.java Outdated Show resolved Hide resolved

pconcannon added 3 commits June 10, 2021 09:45

Merge remote-tracking branch 'origin/master' into JDK-8268469

2abbea1

Merge remote-tracking branch 'origin/master' into JDK-8268469

cd6bfe4

8268469: Removed excessive spacing; corrected misplaced comments

2ae4a57

jodastephen reviewed Jun 16, 2021

View reviewed changes

dfuch reviewed Jun 17, 2021

View reviewed changes

pconcannon added 2 commits June 22, 2021 10:50

Merge remote-tracking branch 'origin/master' into JDK-8268469

5d173e2

8268469: Removed alignment of arrow operators in some cases; reverted…

24ae9e5

… logic of switch/case in LocalDate

dfuch approved these changes Jun 22, 2021

View reviewed changes

naotoj approved these changes Jun 22, 2021

View reviewed changes

irisclark approved these changes Jun 22, 2021

View reviewed changes

ChrisHegarty approved these changes Jun 22, 2021

View reviewed changes

pconcannon added 2 commits June 24, 2021 11:12

Merge remote-tracking branch 'origin/master' into JDK-8268469

a841c3c

Merge remote-tracking branch 'origin/master' into JDK-8268469

c8c1ab5

openjdk bot closed this Jun 25, 2021

openjdk bot added the integrated Pull request has been integrated label Jun 25, 2021

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

pconcannon deleted the JDK-8268469 branch July 6, 2021 10:24

liach mentioned this pull request Jul 27, 2024

请帮忙提名OpenJDK Committer liachmodded/talk#21

Closed

8268469: Update java.time to use switch expressions #4433

8268469: Update java.time to use switch expressions #4433

Uh oh!

Conversation

pconcannon commented Jun 9, 2021 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Jun 9, 2021

Uh oh!

openjdk bot commented Jun 9, 2021

Uh oh!

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

Uh oh!

Webrevs

Uh oh!

LanceAndersen left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

naotoj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jodastephen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jodastephen Jun 16, 2021

Choose a reason for hiding this comment

Uh oh!

jodastephen Jun 16, 2021

Choose a reason for hiding this comment

Uh oh!

ChrisHegarty Jun 16, 2021

Choose a reason for hiding this comment

Uh oh!

jodastephen Jun 16, 2021

Choose a reason for hiding this comment

Uh oh!

dfuch Jun 17, 2021 • 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!

jodastephen Jun 17, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dfuch Jun 17, 2021 • 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!

pconcannon commented Jun 25, 2021

Uh oh!

openjdk bot commented Jun 25, 2021

Uh oh!

openjdk bot commented Jun 25, 2021

Uh oh!

Uh oh!

pconcannon commented Jun 9, 2021 •

edited by openjdk bot

Loading

mlbridge bot commented Jun 9, 2021 •

edited

Loading

openjdk bot commented Jun 9, 2021 •

edited

Loading

dfuch Jun 17, 2021 •

edited

Loading

dfuch Jun 17, 2021 •

edited

Loading