Fix for detector UncallableMethodOfAnonymousClass to not report unused methods of method-local enumerations and records
#2170
Conversation
…sed methods of method-local enumerations and records During compilation, enumerations and records are turned into Java classes with some auto-generated methods. Some of these methods are called by the code but some of them not. However, this is not a programming error or bad practice, these methods must not be considered as dead code because their generation cannot be prevented. Therefore no bug report `UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS` must be issued to such classes even if they are defined inside a method. See issue ([spotbugs#2120](spotbugs#2120))
| if (Values.DOTTED_JAVA_LANG_ENUM.equals(obj.getSuperclassName()) || | ||
| Values.DOTTED_JAVA_LANG_RECORD.equals(obj.getSuperclassName())) { | ||
| return; | ||
| } | ||
|
|
There was a problem hiding this comment.
The test passes even when I revert this change. I assume that the test case is not enough to reproduce the reported problem.
$ ./gradlew clean spotbugs-tests:test --tests=Issue2120TestThere was a problem hiding this comment.
Thank you for noticing this. I forgot to add the inner classes to the test. (I always do the tests first, run them manually to see them fail, and then I do the fix.)
Good idea! Thank you! I will do as you suggested. |
| @@ -59,6 +59,11 @@ public UncallableMethodOfAnonymousClass(BugReporter bugReporter) { | |||
|
|
|||
| @Override | |||
| public void visitJavaClass(JavaClass obj) { | |||
| if (Values.DOTTED_JAVA_LANG_ENUM.equals(obj.getSuperclassName()) || | |||
| Values.DOTTED_JAVA_LANG_RECORD.equals(obj.getSuperclassName())) { | |||
| return; | |||
There was a problem hiding this comment.
There could be extra methods added to an Enum that would validly benefit from the rule, though.
There was a problem hiding this comment.
Hmm, you are right. I will change this to only disregard auto-generated methods.
baloghadamsoftware
requested review from
ThrawnCA and
KengoTODA
and removed request for
ThrawnCA and
KengoTODA
|
No new false positives or crashes on some open-source projects. |
During compilation, enumerations and records are turned into Java classes with some auto-generated methods. Some of these methods are called by the code but some of them not. However, this is not a programming error or bad practice, these methods must not be considered as dead code because their generation cannot be prevented. Therefore no bug report
UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASSmust be issued to such classes even if they are defined inside a method. See issue (#2120)Make sure these boxes are checked before submitting your PR -- thank you!
CHANGELOG.mdif you have changed SpotBugs code