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

JDK-6285888: ChoiceFormat can support unescaped relational symbols in the Format segment #17640

Closed
wants to merge 4 commits into from

Conversation

justin-curtis-lu
Copy link
Member

@justin-curtis-lu justin-curtis-lu commented Jan 30, 2024

Please review this PR and CSR which allows for the Format segment of a ChoiceFormat pattern to use the ChoiceFormat Relational symbols without the need to escape them using quotes. Previously, using a non escaped Relational symbol within a Format segment would throw an IAE.

Implementation wise, this can be achieved by adding an additional check of part == 0 to the relational symbol conditional. This is safe to do, as any subsequent relational symbols should only come after a '|' is parsed, which sets part back to 0. This ensures that for the duration of part = 1 (Format segment), the relational symbols can be used without syntactic meaning.

For example, this change allows behavior such as: new ChoiceFormat("1#The code is #7281"). Previously, the workaround would have been new ChoiceFormat("1#The code is '#'7281") to achieve the same formatted behavior. Please see the CSR for more detail.

Additionally, this change also includes an unrelated grouping of the ChoiceFormat examples under a single header: Usage Information.


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
  • Change requires CSR request JDK-8314822 to be approved

Issues

  • JDK-6285888: ChoiceFormat can support unescaped relational symbols in the Format segment (Bug - P4)
  • JDK-8314822: ChoiceFormat can support unescaped relational symbols in the Format segment (CSR)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17640

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 30, 2024

👋 Welcome back jlu! 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 csr Pull request needs approved CSR before integration rfr Pull request is ready for review labels Jan 30, 2024
@openjdk
Copy link

openjdk bot commented Jan 30, 2024

@justin-curtis-lu 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.

@openjdk openjdk bot added core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Jan 30, 2024
@mlbridge
Copy link

mlbridge bot commented Jan 30, 2024

Webrevs

Comment on lines 182 to 185
* <p>If a <i>Relation</i> symbol is to be used within a <i>Format</i> pattern,
* it must be single quoted. For example,
* {@code new ChoiceFormat("1# '#'1 ").format(1)} returns {@code " #1 "}.
* Use two single quotes in a row to produce a literal single quote. For example,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds right to remove this restriction, but if we were to use | inside Format, shouldn't it still need to be single-quoted?

Copy link
Member Author

@justin-curtis-lu justin-curtis-lu Jan 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, the restriction shouldn't be removed, but rather updated. Fixed in 740686b

Copy link
Member

@naotoj naotoj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@openjdk
Copy link

openjdk bot commented Jan 31, 2024

@justin-curtis-lu 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:

6285888: ChoiceFormat can support unescaped relational symbols in the Format segment

Reviewed-by: naoto

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

  • 5b9b176: 8324174: assert(m->is_entered(current)) failed: invariant
  • 0cc8e5b: 8325042: remove unused JVMDITools test files
  • f292053: 8323621: JDK build should exclude snippet class in java.lang.foreign
  • 62c9530: 8324238: [macOS] java/awt/Frame/ShapeNotSetSometimes/ShapeNotSetSometimes.java fails with the shape has not been applied msg
  • 1f2922a: 8320342: Use PassFailJFrame for TruncatedPopupMenuTest.java
  • 2cd1ba6: 8324981: Shenandoah: Move commit and soft max heap changed methods into heap
  • 1733d2e: 8303374: Implement JEP 455: Primitive Types in Patterns, instanceof, and switch (Preview)
  • 6697160: 8320712: Rewrite BadFactoryTest in pure Java
  • 725314f: 8324771: Obsolete RAMFraction related flags
  • ec6c35c: 8324970: Serial: Refactor signature of maintain_old_to_young_invariant
  • ... and 10 more: https://git.openjdk.org/jdk/compare/f57c7223cf9b732db5255b3e394ee07ff741f074...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 ready Pull request is ready to be integrated and removed csr Pull request needs approved CSR before integration labels Jan 31, 2024
@justin-curtis-lu
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Feb 1, 2024

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

  • 144a08e: 8325078: Better escaping of single and double quotes in javac annotation toString() results
  • b3ecd55: 8324679: Replace NULL with nullptr in HotSpot .ad files
  • 192349e: 8324066: "clhsdb jstack" should not by default scan for j.u.c locks because it can be very slow
  • 6b09a79: 8324974: JFR: EventCompilerPhase should be created as UNTIMED
  • 70e7cdc: 8323670: A few client tests intermittently throw ConcurrentModificationException
  • ac1cd31: 8325096: Test java/security/cert/CertPathBuilder/akiExt/AKISerialNumber.java is failing
  • 8e45182: 8324834: Use _LARGE_FILES on AIX
  • cab74b0: 8324287: Record total and free swap space in JFR
  • 6b84f9b: 8325001: Typo in the javadocs for the Arena::ofShared method
  • cd11059: 8325053: Serial: Move Generation::save_used_region to TenuredGeneration
  • ... and 27 more: https://git.openjdk.org/jdk/compare/f57c7223cf9b732db5255b3e394ee07ff741f074...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Feb 1, 2024
@openjdk openjdk bot closed this Feb 1, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Feb 1, 2024
@openjdk
Copy link

openjdk bot commented Feb 1, 2024

@justin-curtis-lu Pushed as commit d3c3194.

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

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 i18n i18n-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

2 participants