Suppress warnings for spotbugs 4.8.3

jenkinsci/plugin-pom#869 or a subsequent pull request that updates to 4.8.3 will need this change in the plugin to resolve new spotbugs warnings that will be reported by spotbugs 4.8.2 and later. Plugin pom 4.77 is likely to include that new version of spotbugs.
jenkinsci · Jan 16, 2024 · f848806 · f848806
1 parent 2e0bf04
commit f848806
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 1 deletion.
diff --git a/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/AbstractChangesSinceMacro.java b/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/AbstractChangesSinceMacro.java
@@ -4,6 +4,7 @@
 import hudson.model.*;
 import java.io.IOException;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import org.apache.commons.lang.StringUtils;
 import org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro;
 import org.jenkinsci.plugins.tokenmacro.MacroEvaluationException;
@@ -16,12 +17,14 @@ abstract public class AbstractChangesSinceMacro
     @Parameter
     public boolean reverse = false;
     @Parameter
+    @SuppressFBWarnings(value="PA_PUBLIC_PRIMITIVE_ATTRIBUTE", justification="Retain API compatibility.")
     public String format;
     @Parameter
     public boolean showPaths = false;
     @Parameter
     public String changesFormat;
     @Parameter
+    @SuppressFBWarnings(value="PA_PUBLIC_PRIMITIVE_ATTRIBUTE", justification="Retain API compatibility.")
     public String pathFormat = "\\t%p\\n";
     @Parameter
     public boolean showDependencies = false;

diff --git a/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/ChangesSinceLastBuildMacro.java b/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/ChangesSinceLastBuildMacro.java
@@ -1,5 +1,6 @@
 package org.jenkinsci.plugins.tokenmacro.impl;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.Extension;
 import hudson.FilePath;
 import hudson.model.AbstractBuild;
@@ -37,8 +38,10 @@ public class ChangesSinceLastBuildMacro extends DataBoundTokenMacro {
     @Parameter
     public boolean showPaths = false;
     @Parameter
+    @SuppressFBWarnings(value="PA_PUBLIC_PRIMITIVE_ATTRIBUTE", justification="Retain API compatibility.")
     public String format;
     @Parameter
+    @SuppressFBWarnings(value="PA_PUBLIC_PRIMITIVE_ATTRIBUTE", justification="Retain API compatibility.")
     public String pathFormat = PATH_FORMAT_DEFAULT_VALUE;
     @Parameter
     public boolean showDependencies = false;

diff --git a/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/JsonFileMacro.java b/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/JsonFileMacro.java
@@ -1,5 +1,6 @@
 package org.jenkinsci.plugins.tokenmacro.impl;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import com.jayway.jsonpath.DocumentContext;
 import com.jayway.jsonpath.JsonPath;
 import hudson.Extension;
@@ -40,6 +41,7 @@ public class JsonFileMacro extends DataBoundTokenMacro {
     public String file = null;
 
     @Parameter
+    @SuppressFBWarnings(value="PA_PUBLIC_PRIMITIVE_ATTRIBUTE", justification="Retain API compatibility.")
     public String path = null;
 
     @Parameter
@@ -154,4 +156,4 @@ public String call() throws IOException {
             return result;
         }
     }
-}
+}
diff --git a/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/WorkspaceFileMacro.java b/src/main/java/org/jenkinsci/plugins/tokenmacro/impl/WorkspaceFileMacro.java
@@ -23,6 +23,7 @@
  */
 package org.jenkinsci.plugins.tokenmacro.impl;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.EnvVars;
 import hudson.Extension;
 import hudson.FilePath;
@@ -49,6 +50,7 @@
 @Extension
 public class WorkspaceFileMacro extends DataBoundTokenMacro  {
     @Parameter(required=true)
+    @SuppressFBWarnings(value="PA_PUBLIC_PRIMITIVE_ATTRIBUTE", justification="Retain API compatibility.")
     public String path = "";
     @Parameter
     public String fileNotFoundMessage = "ERROR: File '%s' does not exist";