Issue #14084: fix Checker violation for nonnegative integer argument

checkstyle · Mar 17, 2024 · 7fa2268 · 7fa2268
1 parent 2126aa1
commit 7fa2268
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 13 deletions.
diff --git a/config/checker-framework-suppressions/checker-index-suppressions.xml b/config/checker-framework-suppressions/checker-index-suppressions.xml
@@ -11,17 +11,6 @@
     </details>
   </checkerFrameworkError>
 
-  <checkerFrameworkError unstable="false">
-    <fileName>src/main/java/com/puppycrawl/tools/checkstyle/DetailAstImpl.java</fileName>
-    <specifier>argument</specifier>
-    <message>incompatible argument for parameter bitIndex of BitSet.get.</message>
-    <lineContent>return getBranchTokenTypes().get(tokenType);</lineContent>
-    <details>
-      found   : int
-      required: @NonNegative int
-    </details>
-  </checkerFrameworkError>
-
   <checkerFrameworkError unstable="false">
     <fileName>src/main/java/com/puppycrawl/tools/checkstyle/DetailAstImpl.java</fileName>
     <specifier>argument</specifier>

diff --git a/config/import-control.xml b/config/import-control.xml
@@ -23,6 +23,7 @@
   <allow pkg="javax.xml.parsers"/>
   <allow pkg="org.apache.commons.beanutils"/>
   <allow pkg="org.apache.commons.logging"/>
+  <allow class="org.checkerframework.checker.index.qual.NonNegative"/>
   <allow pkg="org.xml.sax"/>
 
   <!-- The local ones -->

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/DetailAstImpl.java b/src/main/java/com/puppycrawl/tools/checkstyle/DetailAstImpl.java
@@ -23,6 +23,7 @@
 import java.util.List;
 
 import org.antlr.v4.runtime.Token;
+import org.checkerframework.checker.index.qual.NonNegative;
 
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
 import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
@@ -383,7 +384,7 @@ private BitSet getBranchTokenTypes() {
     }
 
     @Override
-    public boolean branchContains(int tokenType) {
+    public boolean branchContains(@NonNegative int tokenType) {
         return getBranchTokenTypes().get(tokenType);
     }
 

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/DetailAST.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/DetailAST.java
@@ -19,6 +19,8 @@
 
 package com.puppycrawl.tools.checkstyle.api;
 
+import org.checkerframework.checker.index.qual.NonNegative;
+
 /**
  * An interface of Checkstyle's AST nodes for traversing trees generated from the
  * Java code. The main purpose of this interface is to abstract away ANTLR
@@ -105,7 +107,7 @@ public interface DetailAST {
      *      for more details.
      */
     @Deprecated(since = "8.43")
-    boolean branchContains(int type);
+    boolean branchContains(@NonNegative int type);
 
     /**
      * Returns the previous sibling or null if no such sibling exists.