docs: improve javadoc for ResourceOperation on resource cloning and matching - #3502
Merged
Merged
Conversation
…atching Add java doc remark that the desired resource has to be clone (or fresh instance created) in order to have the maching work correctly Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the public Javadoc on ResourceOperations to clarify how matching behaves when comparing desired vs. actual resources, especially when the actual resource comes from an informer cache.
Changes:
- Adds a new Javadoc note about matching secondary resources read from cache and the implications of cloning.
- References
ConfigurationService#cloneSecondaryResourcesWhenGettingFromCache()as a mitigation for cache-mutation risks.
xstefank
approved these changes
Jul 16, 2026
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.
Add java doc remark that the desired resource has to be clone (or fresh instance created)
in order to have the maching work correctly
Signed-off-by: Attila Mészáros a_meszaros@apple.com