8263472: Specification of JComponent::updateUI should document that the default implementation does nothing

[prsadhuk]

It's unclear from the spec that the original implementation of the method JComponent.updateUI() does nothing which needs to be explicitly stated in the javadoc.

---

Progress

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

Issue

• JDK-8263472: Specification of JComponent::updateUI should document that the default implementation does nothing

Reviewers

• Alexey Ivanov (@aivanov-jdk - Reviewer) ⚠️ Review applies to ec7755a
• Joe Darcy (@jddarcy - Reviewer) ⚠️ Review applies to ec7755a

Download

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

To update a local copy of the PR:
$ git checkout pull/2955
$ git pull https://git.openjdk.java.net/jdk pull/2955/head

[bridgekeeper]

👋 Welcome back psadhukhan! 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]

@prsadhuk The following label will be automatically applied to this pull request:

• swing

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]

Webrevs

• 08: Full - Incremental (f48a043)
• 07: Full - Incremental (ec7755a)
• 06: Full - Incremental (36cccda)
• 05: Full - Incremental (5b15e87)
• 04: Full - Incremental (50b997d)
• 03: Full - Incremental (39c4a72)
• 02: Full - Incremental (a648420)
• 01: Full - Incremental (2d5e911)
• 00: Full (9a0b275)

[mrserb]

Do we really want to specify this as a noop method? In this case, we will not be able to change this implementation in the future.

[prsadhuk]

Do we really want to specify this as a noop method? In this case, we will not be able to change this implementation in the future.

I thought about it earlier but I raised this PR as I don't see this method was updated from inception so I was not sure if it will be in future and also since it already says "JComponent subclasses must override this method" so a noop default implementation will not be a problem, I guess.

[openjdk]

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

8263472: Specification of JComponent::updateUI should document that the default implementation does nothing

Reviewed-by: aivanov, darcy

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

• 4155533: 8258753: StartTlsResponse.close() hangs due to synchronization issues
• 3e18330: 8264018: AArch64: NEON loadV2 and storeV2 addressing is wrong
• 0ff8168: 8258957: DocLint: check for HTML start element at end of body
• 3d7f912: 8220266: add support for additional metadata in add/remove programs
• 37f494c: 8260619: Add final modifier to several DataFlavor static fields
• cfc9aa3: 8264002: Delete outdated assumptions about ColorSpace initialization
• 623f0b6: 8262235: Remove unnecessary logic in hugetlbfs_sanity_check()
• 1a13c9e: 8263473: Update annotation terminology (2)
• 3e751a5: 8263198: javadoc HELP page
• 5ca5962: 8259926: Error in jpackage sample usage in the help text
• ... and 616 more: https://git.openjdk.java.net/jdk/compare/5183d8ae1eec86202eace2c4770f81edbc73cb68...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.

[mrserb]

I thought about it earlier but I raised this PR as I don't see this method was updated from inception so I was not sure if it will be in future and also since it already says "JComponent subclasses must override this method" so a noop default implementation will not be a problem, I guess.

Based on the current spec we may add some kind of assertion that this method must not be called.

[aivanov-jdk]

I thought about it earlier but I raised this PR as I don't see this method was updated from inception so I was not sure if it will be in future and also since it already says "JComponent subclasses must override this method" so a noop default implementation will not be a problem, I guess.

Based on the current spec we may add some kind of assertion that this method must not be called.

I'm afraid this can be interpreted in a wrong way: never call JComponent.updateUI(), which is not what we want to say, is it?

[mrserb]

Do we need a CSR?

[prsadhuk]

I have added CSR just in case...https://bugs.openjdk.java.net/browse/JDK-8263845....please review

[mrserb]

/csr

[openjdk]

@mrserb this pull request will not be integrated until the CSR request JDK-8263845 for issue JDK-8263472 has been approved.

[prsadhuk]

/integrate

[openjdk]

@prsadhuk Since your change was applied there have been 648 commits pushed to the master branch:

• e47dfb8: 8264062: Use the blessed modifier order in jdk.jfr
• 5a930c4: 8264135: UnsafeGetStableArrayElement should account for different JIT implementation details
• bb354b9: 8264166: OopStorage should support specifying MEMFLAGS for allocations
• 41657b1: 8261551: Remove special CDS handling in Metaspace::allocate
• fe8ef32: 8264151: ciMethod::ensure_method_data() should return false is loading resulted in empty state
• 4e708e5: 8260862: JFR: New configure command for the jfr tool
• 2593196: 8264161: BigDecimal#stripTrailingZeros can throw undocumented ArithmeticException
• 2a5e0dd: 8262081: vmTestbase/nsk/jdi/ThreadDeathRequest/addThreadFilter/addthreadfilter001/TestDescription.java failed with "ERROR: eventSet1.size() != 3 :: 2"
• 374272f: 8261502: ECDHKeyAgreement: Allows alternate ECPrivateKey impl and revised exception handling
• dbc9e4b: 8253795: Implementation of JEP 391: macOS/AArch64 Port
• ... and 638 more: https://git.openjdk.java.net/jdk/compare/5183d8ae1eec86202eace2c4770f81edbc73cb68...master

Your commit was automatically rebased without conflicts.

Pushed as commit 4fbb7c2.

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