refactor: cleanup shutdown hook registration method documentation#3381
Closed
metacosm wants to merge 0 commit into
Closed
refactor: cleanup shutdown hook registration method documentation#3381metacosm wants to merge 0 commit into
metacosm wants to merge 0 commit into
Conversation
Collaborator
metacosm
commented
May 27, 2026
- refactor: cleanup shutdown hook registration method documentation
- refactor: minor improvements
Contributor
There was a problem hiding this comment.
Pull request overview
Cleans up the installShutdownHook API documentation by formally deprecating the Duration-based overload (whose argument is now ignored in favor of ConfigurationService#reconciliationTerminationTimeout()) and adds a Javadoc to stop(). Also makes minor refactoring improvements in LeaderElectionManager: extracting REQUIRED_VERBS as a constant, using an unmodifiable set for collected verbs, and joining missing verbs into a comma-separated string for the error message.
Changes:
- Split
installShutdownHook(Duration)into a deprecated delegating overload plus a documented no-arginstallShutdownHook(), and add Javadoc tostop(). - Extract
REQUIRED_VERBSconstant and switch verb collection totoUnmodifiableSet()inLeaderElectionManager#checkLeaseAccess. - Format the missing-verbs portion of the
OperatorExceptionmessage as a comma-separated string.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| operator-framework-core/.../Operator.java | Deprecates installShutdownHook(Duration), adds Javadoc for new no-arg overload and stop(). |
| operator-framework-core/.../LeaderElectionManager.java | Refactors lease access check: constant for required verbs, unmodifiable set, joined missing-verb message. |
csviri
approved these changes
May 27, 2026
xstefank
approved these changes
May 27, 2026
Collaborator
|
@metacosm feel free to merge this, thx! |
Collaborator
Author
Collaborator
|
Will merge that, PR, please rebase this on it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.