SONARJAVA-6430 Centralize class-like tree kinds

its/autoscan/src/test/resources/autoscan/diffs/diff_S1172.json

@@ -1,6 +1,6 @@
 {
   "ruleKey": "S1172",
   "hasTruePositives": true,
-  "falseNegatives": 32,
+  "falseNegatives": 33,
   "falsePositives": 0
 }

java-checks-test-sources/default/src/main/java/checks/jspecify/nullmarked/RedundantNullabilityAnnotationsCheckSample.java

@@ -205,6 +205,20 @@ static interface InnerRecord {
 
   }
 
+  @NullMarked // Noncompliant {{Remove redundant annotation @NullMarked at class level as inside scope annotation @NullMarked at package level.}}
+  static @interface Annotation {
+  }
+
+  @NullMarked // Noncompliant {{Remove redundant annotation @NullMarked at class level as inside scope annotation @NullMarked at package level.}}
+  enum InnerEnum {
+    A,
+    B;
+
+    public void f(@NonNull String s) { // Noncompliant {{Remove redundant annotation @NonNull as inside scope annotation @NullMarked at class level.}}
+      // Do something
+    }
+  }
+
 }
 
 enum TEST_COVERAGE {

java-checks/src/main/java/org/sonar/java/checks/AbstractCallToDeprecatedCodeChecker.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.java.checks;
 
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
@@ -29,6 +28,7 @@
 import org.sonar.plugins.java.api.tree.MethodTree;
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.plugins.java.api.tree.VariableTree;
+import org.sonarsource.analyzer.commons.collections.ListUtils;
 
 public abstract class AbstractCallToDeprecatedCodeChecker extends IssuableSubscriptionVisitor {
 
@@ -41,7 +41,7 @@ public final void leaveFile(JavaFileScannerContext context) {
 
   @Override
   public final List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(Tree.Kind.IDENTIFIER, Tree.Kind.CLASS, Tree.Kind.ENUM, Tree.Kind.INTERFACE, Tree.Kind.ANNOTATION_TYPE, Tree.Kind.METHOD, Tree.Kind.CONSTRUCTOR);
+    return ListUtils.concat(Tree.CLASS_KINDS, List.of(Tree.Kind.IDENTIFIER, Tree.Kind.METHOD, Tree.Kind.CONSTRUCTOR));
   }
 
   @Override
@@ -120,7 +120,7 @@ private static boolean isDeprecatedMethod(Tree tree) {
   }
 
   private static boolean isDeprecatedClassTree(Tree tree) {
-    return tree.is(Tree.Kind.CLASS, Tree.Kind.ENUM, Tree.Kind.INTERFACE, Tree.Kind.ANNOTATION_TYPE) && ((ClassTree) tree).symbol().isDeprecated();
+    return Tree.CLASS_KINDS.contains(tree.kind()) && ((ClassTree) tree).symbol().isDeprecated();
   }
 
   boolean isFlaggedForRemoval(Symbol deprecatedSymbol) {

java-checks/src/main/java/org/sonar/java/checks/CallOuterPrivateMethodCheck.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.java.checks;
 
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
@@ -44,7 +43,7 @@ public class CallOuterPrivateMethodCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(Tree.Kind.CLASS, Tree.Kind.INTERFACE);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/CallSuperMethodFromInnerClassCheck.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.java.checks;
 
-import java.util.Arrays;
 import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.java.model.ExpressionUtils;
@@ -34,7 +33,7 @@ public class CallSuperMethodFromInnerClassCheck extends IssuableSubscriptionVisi
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(Tree.Kind.CLASS, Tree.Kind.INTERFACE);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/ClassFieldCountCheck.java

@@ -16,6 +16,7 @@
  */
 package org.sonar.java.checks;
 
+import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
@@ -24,9 +25,6 @@
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.plugins.java.api.tree.VariableTree;
 
-import java.util.Arrays;
-import java.util.List;
-
 import static org.sonar.java.checks.helpers.ExpressionsHelper.reportOnClassTree;
 
 @Rule(key = "S1820")
@@ -43,7 +41,7 @@ public class ClassFieldCountCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(Tree.Kind.CLASS, Tree.Kind.INTERFACE, Tree.Kind.ENUM);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/CollectionIsEmptyCheck.java

@@ -63,13 +63,7 @@ private enum EmptyComparisonType {
     Tree.Kind.GREATER_THAN,
     Tree.Kind.GREATER_THAN_OR_EQUAL_TO
   };
-  private static final Tree.Kind[] CLASS_TREES = {
-    Tree.Kind.CLASS,
-    Tree.Kind.ENUM,
-    Tree.Kind.INTERFACE,
-    Tree.Kind.RECORD,
-    Tree.Kind.ANNOTATION_TYPE
-  };
+  private static final Tree.Kind[] CLASS_TREES = Tree.CLASS_KINDS.toArray(new Tree.Kind[0]);
   private static final Deque<Boolean> IS_COLLECTION_ENCLOSING_TYPES_STACK = new LinkedList<>();
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/ExpressionComplexityCheck.java

@@ -16,6 +16,10 @@
  */
 package org.sonar.java.checks;
 
+import java.util.Collections;
+import java.util.Deque;
+import java.util.LinkedList;
+import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.java.checks.helpers.MethodTreeUtils;
@@ -24,12 +28,7 @@
 import org.sonar.plugins.java.api.tree.LambdaExpressionTree;
 import org.sonar.plugins.java.api.tree.MethodTree;
 import org.sonar.plugins.java.api.tree.Tree;
-
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.Deque;
-import java.util.LinkedList;
-import java.util.List;
+import org.sonarsource.analyzer.commons.collections.ListUtils;
 
 @Rule(key = "S1067")
 public class ExpressionComplexityCheck extends IssuableSubscriptionVisitor {
@@ -56,9 +55,7 @@ public void setContext(JavaFileScannerContext context) {
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(
-      Tree.Kind.CLASS,
-      Tree.Kind.RECORD,
+    return ListUtils.concat(Tree.CLASS_KINDS, List.of(
       Tree.Kind.POSTFIX_INCREMENT,
       Tree.Kind.POSTFIX_DECREMENT,
       Tree.Kind.PREFIX_INCREMENT,
@@ -118,12 +115,12 @@ public List<Tree.Kind> nodesToVisit() {
       Tree.Kind.IDENTIFIER,
       Tree.Kind.ARRAY_TYPE,
       Tree.Kind.LAMBDA_EXPRESSION,
-      Tree.Kind.PRIMITIVE_TYPE);
+      Tree.Kind.PRIMITIVE_TYPE));
   }
 
   @Override
   public void visitNode(Tree tree) {
-    if (tree.is(Tree.Kind.CLASS, Tree.Kind.RECORD, Tree.Kind.NEW_ARRAY) || isLambdaWithBlock(tree)) {
+    if (Tree.CLASS_KINDS.contains(tree.kind()) || tree.is(Tree.Kind.NEW_ARRAY) || isLambdaWithBlock(tree)) {
       count.push(0);
       level.push(0);
     } else {
@@ -136,7 +133,7 @@ public void visitNode(Tree tree) {
 
   @Override
   public void leaveNode(Tree tree) {
-    if (tree.is(Tree.Kind.CLASS, Tree.Kind.RECORD, Tree.Kind.NEW_ARRAY) || isLambdaWithBlock(tree)) {
+    if (Tree.CLASS_KINDS.contains(tree.kind()) || tree.is(Tree.Kind.NEW_ARRAY) || isLambdaWithBlock(tree)) {
       count.pop();
       level.pop();
     } else {
@@ -155,7 +152,7 @@ public void leaveNode(Tree tree) {
 
   private static boolean isInsideEquals(Tree tree) {
     Tree parent = tree.parent();
-    while (parent != null && !parent.is(Tree.Kind.CLASS, Tree.Kind.RECORD)) {
+    while (parent != null && !Tree.CLASS_KINDS.contains(parent.kind())) {
       if (parent.is(Tree.Kind.METHOD) && MethodTreeUtils.isEqualsMethod((MethodTree) parent)) {
         return true;
       }

java-checks/src/main/java/org/sonar/java/checks/HiddenFieldCheck.java

@@ -17,7 +17,6 @@
 package org.sonar.java.checks;
 
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.Deque;
 import java.util.HashSet;
@@ -27,8 +26,6 @@
 import java.util.Set;
 import javax.annotation.Nullable;
 import org.sonar.check.Rule;
-import org.sonarsource.analyzer.commons.collections.MapBuilder;
-import org.sonarsource.analyzer.commons.collections.SetUtils;
 import org.sonar.java.model.JavaTree;
 import org.sonar.java.model.LineUtils;
 import org.sonar.java.model.ModifiersUtils;
@@ -42,6 +39,9 @@
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.plugins.java.api.tree.VariableTree;
 import org.sonarsource.analyzer.commons.annotations.DeprecatedRuleKey;
+import org.sonarsource.analyzer.commons.collections.ListUtils;
+import org.sonarsource.analyzer.commons.collections.MapBuilder;
+import org.sonarsource.analyzer.commons.collections.SetUtils;
 
 @DeprecatedRuleKey(ruleKey = "HiddenFieldCheck", repositoryKey = "squid")
 @Rule(key = "S1117")
@@ -53,18 +53,12 @@ public class HiddenFieldCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(
-        Tree.Kind.CLASS,
-        Tree.Kind.ENUM,
-        Tree.Kind.INTERFACE,
-        Tree.Kind.ANNOTATION_TYPE,
-        Tree.Kind.RECORD,
-        Tree.Kind.IMPLICIT_CLASS,
-        Tree.Kind.VARIABLE,
-        Tree.Kind.METHOD,
-        Tree.Kind.CONSTRUCTOR,
-        Tree.Kind.STATIC_INITIALIZER
-    );
+    return ListUtils.concat(Tree.CLASS_KINDS, List.of(
+      Tree.Kind.VARIABLE,
+      Tree.Kind.METHOD,
+      Tree.Kind.CONSTRUCTOR,
+      Tree.Kind.STATIC_INITIALIZER
+    ));
   }
 
   @Override
@@ -131,14 +125,7 @@ private static boolean isInStaticInnerClass(VariableTree hiddenVariable, Variabl
   }
 
   private static boolean isClassTree(Tree tree) {
-    return tree.is(
-      Tree.Kind.CLASS,
-      Tree.Kind.ENUM,
-      Tree.Kind.INTERFACE,
-      Tree.Kind.ANNOTATION_TYPE,
-      Tree.Kind.RECORD,
-      Tree.Kind.IMPLICIT_CLASS
-    );
+    return Tree.CLASS_KINDS.contains(tree.kind());
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/InnerClassTooManyLinesCheck.java

@@ -16,6 +16,7 @@
  */
 package org.sonar.java.checks;
 
+import java.util.List;
 import org.sonar.check.Rule;
 import org.sonar.check.RuleProperty;
 import org.sonar.java.checks.helpers.ExpressionsHelper;
@@ -27,9 +28,6 @@
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.plugins.java.api.tree.Tree.Kind;
 
-import java.util.Arrays;
-import java.util.List;
-
 @Rule(key = "S2972")
 public class InnerClassTooManyLinesCheck extends IssuableSubscriptionVisitor {
 
@@ -42,7 +40,7 @@ public class InnerClassTooManyLinesCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Kind> nodesToVisit() {
-    return Arrays.asList(Kind.CLASS, Kind.ENUM, Kind.INTERFACE, Kind.ANNOTATION_TYPE);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/InterfaceOrSuperclassShadowingCheck.java

@@ -16,24 +16,22 @@
  */
 package org.sonar.java.checks;
 
+import java.util.List;
+import java.util.Locale;
+import javax.annotation.Nullable;
 import org.sonar.check.Rule;
 import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
 import org.sonar.plugins.java.api.semantic.Symbol;
 import org.sonar.plugins.java.api.semantic.Type;
 import org.sonar.plugins.java.api.tree.ClassTree;
 import org.sonar.plugins.java.api.tree.Tree;
-import javax.annotation.Nullable;
-
-import java.util.Arrays;
-import java.util.List;
-import java.util.Locale;
 
 @Rule(key = "S2176")
 public class InterfaceOrSuperclassShadowingCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(Tree.Kind.CLASS, Tree.Kind.INTERFACE, Tree.Kind.RECORD);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/MembersDifferOnlyByCapitalizationCheck.java

@@ -16,7 +16,6 @@
  */
 package org.sonar.java.checks;
 
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
@@ -47,7 +46,7 @@ public class MembersDifferOnlyByCapitalizationCheck extends IssuableSubscription
 
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return Arrays.asList(Tree.Kind.CLASS, Tree.Kind.INTERFACE, Tree.Kind.ENUM, Tree.Kind.RECORD);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/MultipleMainInstancesCheck.java

@@ -32,7 +32,7 @@
 public class MultipleMainInstancesCheck extends IssuableSubscriptionVisitor implements JavaVersionAwareVisitor {
   @Override
   public List<Tree.Kind> nodesToVisit() {
-    return List.of(Tree.Kind.CLASS, Tree.Kind.INTERFACE, Tree.Kind.ENUM, Tree.Kind.RECORD, Tree.Kind.IMPLICIT_CLASS);
+    return Tree.CLASS_KINDS;
   }
 
   @Override

java-checks/src/main/java/org/sonar/java/checks/OneDeclarationPerLineCheck.java

@@ -17,7 +17,6 @@
 package org.sonar.java.checks;
 
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -36,6 +35,7 @@
 import org.sonar.plugins.java.api.tree.Tree;
 import org.sonar.plugins.java.api.tree.Tree.Kind;
 import org.sonar.plugins.java.api.tree.VariableTree;
+import org.sonarsource.analyzer.commons.collections.ListUtils;
 
 import static org.sonar.java.reporting.AnalyzerMessage.textSpanBetween;
 
@@ -46,12 +46,12 @@ public class OneDeclarationPerLineCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Kind> nodesToVisit() {
-    return Arrays.asList(Kind.INTERFACE, Kind.CLASS, Kind.ENUM, Kind.ANNOTATION_TYPE, Kind.BLOCK, Kind.STATIC_INITIALIZER, Kind.CASE_GROUP);
+    return ListUtils.concat(Tree.CLASS_KINDS, List.of(Kind.BLOCK, Kind.STATIC_INITIALIZER, Kind.CASE_GROUP));
   }
 
   @Override
   public void visitNode(Tree tree) {
-    if (tree.is(Kind.INTERFACE, Kind.CLASS, Kind.ENUM, Kind.ANNOTATION_TYPE)) {
+    if (Tree.CLASS_KINDS.contains(tree.kind())) {
       // Field class declaration
       checkVariables(((ClassTree) tree).members());
     } else if (tree.is(Kind.BLOCK, Kind.STATIC_INITIALIZER)) {