Exclude methods returning any object from potential setters when deciding on the mutability of a class #1674
Conversation
This file contains 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
added 2 commits
August 31, 2021 17:48
…ding on the mutability of a class Methods which returned an instance of the owning class itself are probably no setters because they usually return a new instance instead of modifying the existing one. The algorithm did care for that, but it turned out that in many cases this is not enough. Some immutable classes contain methods with a setter-like name which return an instance of a class which is different from their owning class. This patch changes the behavior of the alrogithm to skip these methods as well.
1 task
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.
Methods which returned an instance of the owning class itself are probably no setters because they usually return a new instance instead of modifying the existing one. The algorithm did care for that, but it turned out that in many cases this is not enough. Some immutable classes contain methods with a setter-like name which return an instance of a class which is different from their owning class. This patch changes the behavior of the alrogithm to skip these methods as well.
Partial fix for issue [#1601](https://github.com/spotbugs/spotbugs/issues/1601\)
Make sure these boxes are checked before submitting your PR -- thank you!
CHANGELOG.mdif you have changed SpotBugs code