Switch to spotbugs-annotations (#258)

* Switch to `spotbugs-annotations` * JSR 305 was still being used in other modules
jenkinsci · Aug 16, 2021 · 4ac80fd · 4ac80fd
1 parent ffde0f4
commit 4ac80fd
Show file tree

Hide file tree

Showing 30 changed files with 104 additions and 108 deletions.
diff --git a/core/pom.xml b/core/pom.xml
@@ -151,11 +151,6 @@
       <version>1.0.0</version>
       <scope>test</scope>
     </dependency>
-    <dependency>
-      <groupId>com.google.code.findbugs</groupId>
-      <artifactId>jsr305</artifactId>
-      <version>2.0.1</version>
-    </dependency>
     <dependency>
       <groupId>com.jcraft</groupId>
       <artifactId>jzlib</artifactId>

diff --git a/core/src/main/java/org/kohsuke/stapler/AcceptHeader.java b/core/src/main/java/org/kohsuke/stapler/AcceptHeader.java
@@ -25,7 +25,7 @@ of this software and associated documentation files (the "Software"), to deal
 import org.apache.commons.lang.StringUtils;
 import org.apache.commons.lang.math.NumberUtils;
 
-import javax.annotation.Nullable;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import javax.servlet.http.HttpServletResponse;
 import java.util.ArrayList;
 import java.util.Arrays;

diff --git a/core/src/main/java/org/kohsuke/stapler/DispatchValidator.java b/core/src/main/java/org/kohsuke/stapler/DispatchValidator.java
@@ -24,8 +24,8 @@
 
 package org.kohsuke.stapler;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
  * Validates dispatch requests. This validator is configured through {@link WebApp#setDispatchValidator(DispatchValidator)}
@@ -47,7 +47,7 @@ public interface DispatchValidator {
      * @param rsp the HTTP response
      * @return true if the request should be dispatched, false if not, or null if unknown or neutral
      */
-    @CheckForNull Boolean isDispatchAllowed(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp);
+    @CheckForNull Boolean isDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp);
 
     /**
      * Checks if the given request and response should be allowed to dispatch a view on an optionally present node
@@ -59,21 +59,21 @@ public interface DispatchValidator {
      * @param node     the node being dispatched if present
      * @return true if the view should be allowed to dispatch, false if it should not, or null if unknown
      */
-    default @CheckForNull Boolean isDispatchAllowed(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp, @Nonnull String viewName, @CheckForNull Object node) {
+    default @CheckForNull Boolean isDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp, @NonNull String viewName, @CheckForNull Object node) {
         return isDispatchAllowed(req, rsp);
     }
 
     /**
      * Allows the given request to be dispatched. Further calls to {@link #isDispatchAllowed(StaplerRequest, StaplerResponse)}
      * should return true for the same request.
      */
-    void allowDispatch(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp);
+    void allowDispatch(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp);
 
     /**
      * Throws a {@link CancelRequestHandlingException} if the given request is not
      * {@linkplain #isDispatchAllowed(StaplerRequest, StaplerResponse) allowed}.
      */
-    default void requireDispatchAllowed(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp) throws CancelRequestHandlingException {
+    default void requireDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp) throws CancelRequestHandlingException {
         Boolean allowed = isDispatchAllowed(req, rsp);
         if (allowed == null || !allowed) {
             throw new CancelRequestHandlingException();
@@ -85,12 +85,12 @@ default void requireDispatchAllowed(@Nonnull StaplerRequest req, @Nonnull Staple
      */
     DispatchValidator DEFAULT = new DispatchValidator() {
         @Override
-        public Boolean isDispatchAllowed(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp) {
+        public Boolean isDispatchAllowed(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp) {
             return true;
         }
 
         @Override
-        public void allowDispatch(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp) {
+        public void allowDispatch(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp) {
             // no-op
         }
     };

diff --git a/core/src/main/java/org/kohsuke/stapler/EvaluationTrace.java b/core/src/main/java/org/kohsuke/stapler/EvaluationTrace.java
@@ -23,7 +23,7 @@
 
 package org.kohsuke.stapler;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.List;
 import java.util.ArrayList;
 import java.io.PrintWriter;
@@ -80,7 +80,7 @@ public static void trace(StaplerRequest req, String message) {
 
         private static volatile List<ApplicationTracer> tracers;
 
-        @Nonnull
+        @NonNull
         private static List<ApplicationTracer> getTracers() {
             synchronized (ApplicationTracer.class) {
                 if (tracers == null) {

diff --git a/core/src/main/java/org/kohsuke/stapler/Facet.java b/core/src/main/java/org/kohsuke/stapler/Facet.java
@@ -31,8 +31,8 @@
 import org.kohsuke.stapler.event.FilteredDispatchTriggerListener;
 import org.kohsuke.stapler.lang.Klass;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import javax.servlet.RequestDispatcher;
 import javax.servlet.ServletException;
 import java.io.IOException;
@@ -176,7 +176,7 @@ protected boolean isBasename(String potentialPath){
      * If you do want to have an extension added, you must ensure you provide the dot at the first character position, 
      * see JellyFacet
      */
-    protected @Nonnull String getExtensionSuffix() {
+    protected @NonNull String getExtensionSuffix() {
         return "";
     } 
 
@@ -195,11 +195,11 @@ protected boolean isBasename(String potentialPath){
      * @see WebApp#setFilteredDispatchTriggerListener(FilteredDispatchTriggerListener)
      * @since TODO
      */
-    @Nonnull protected <S> Dispatcher createValidatingDispatcher(@Nonnull AbstractTearOff<?, ? extends S, ?> scriptLoader,
-                                                                 @Nonnull ScriptExecutor<? super S> scriptExecutor) {
+    @NonNull protected <S> Dispatcher createValidatingDispatcher(@NonNull AbstractTearOff<?, ? extends S, ?> scriptLoader,
+                                                                 @NonNull ScriptExecutor<? super S> scriptExecutor) {
         return new Dispatcher() {
             @Override
-            public boolean dispatch(@Nonnull RequestImpl req, @Nonnull ResponseImpl rsp, @CheckForNull Object node) throws ServletException {
+            public boolean dispatch(@NonNull RequestImpl req, @NonNull ResponseImpl rsp, @CheckForNull Object node) throws ServletException {
                 String next = req.tokens.peek();
                 if (next == null) {
                     return false;
@@ -261,10 +261,10 @@ public String toString() {
      * Handles an index request by dispatching a script.
      * @since TODO
      */
-    protected <S> boolean handleIndexRequest(@Nonnull AbstractTearOff<?, ? extends S, ?> scriptLoader,
-                                             @Nonnull ScriptExecutor<? super S> scriptExecutor,
-                                             @Nonnull RequestImpl req,
-                                             @Nonnull ResponseImpl rsp,
+    protected <S> boolean handleIndexRequest(@NonNull AbstractTearOff<?, ? extends S, ?> scriptLoader,
+                                             @NonNull ScriptExecutor<? super S> scriptExecutor,
+                                             @NonNull RequestImpl req,
+                                             @NonNull ResponseImpl rsp,
                                              @CheckForNull Object node)
             throws ServletException, IOException {
         S script;
@@ -302,10 +302,10 @@ protected <S> boolean handleIndexRequest(@Nonnull AbstractTearOff<?, ? extends S
      * @see WebApp#setFilteredDispatchTriggerListener(FilteredDispatchTriggerListener)
      * @since TODO
      */
-    @CheckForNull protected <S> RequestDispatcher createRequestDispatcher(@Nonnull AbstractTearOff<?, ? extends S, ?> scriptLoader,
-                                                                          @Nonnull ScriptExecutor<? super S> scriptExecutor,
+    @CheckForNull protected <S> RequestDispatcher createRequestDispatcher(@NonNull AbstractTearOff<?, ? extends S, ?> scriptLoader,
+                                                                          @NonNull ScriptExecutor<? super S> scriptExecutor,
                                                                           @CheckForNull Object it,
-                                                                          @Nonnull String viewName) {
+                                                                          @NonNull String viewName) {
         return ScriptRequestDispatcher.newRequestDispatcher(scriptLoader, scriptExecutor, viewName, it);
     }
 }
diff --git a/core/src/main/java/org/kohsuke/stapler/HttpRedirect.java b/core/src/main/java/org/kohsuke/stapler/HttpRedirect.java
@@ -23,7 +23,7 @@
 
 package org.kohsuke.stapler;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import javax.servlet.ServletException;
 import java.io.IOException;
 
@@ -39,11 +39,11 @@ public final class HttpRedirect extends RuntimeException implements HttpResponse
     private final int statusCode;
     private final String url;
 
-    public HttpRedirect(@Nonnull String url) {
+    public HttpRedirect(@NonNull String url) {
         this(SC_MOVED_TEMPORARILY,url);
     }
 
-    public HttpRedirect(int statusCode, @Nonnull String url) {
+    public HttpRedirect(int statusCode, @NonNull String url) {
         this.statusCode = statusCode;
         if (url == null) {
             throw new NullPointerException();

diff --git a/core/src/main/java/org/kohsuke/stapler/HttpResponses.java b/core/src/main/java/org/kohsuke/stapler/HttpResponses.java
@@ -23,7 +23,7 @@
 
 package org.kohsuke.stapler;
 
-import javax.annotation.CheckForNull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;

diff --git a/core/src/main/java/org/kohsuke/stapler/LocaleDrivenResourceProvider.java b/core/src/main/java/org/kohsuke/stapler/LocaleDrivenResourceProvider.java
@@ -23,8 +23,8 @@
 
 package org.kohsuke.stapler;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import java.net.URL;
 import java.util.ArrayList;
 import java.util.List;
@@ -52,7 +52,7 @@ public abstract class LocaleDrivenResourceProvider {
      * @return the URL to the file, if it is to be overridden, null otherwise.
      */
     @CheckForNull
-    abstract public URL lookup(@Nonnull String path);
+    abstract public URL lookup(@NonNull String path);
 
     private static List<LocaleDrivenResourceProvider> localeDrivenResourceProviders;
 

diff --git a/core/src/main/java/org/kohsuke/stapler/ResponseImpl.java b/core/src/main/java/org/kohsuke/stapler/ResponseImpl.java
@@ -38,7 +38,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import javax.servlet.ServletException;
 import javax.servlet.ServletOutputStream;
 import javax.servlet.http.HttpServletRequest;
@@ -132,7 +132,7 @@ public void forwardToPreviousPage(StaplerRequest request) throws ServletExceptio
     }
 
     @Override
-    public void sendRedirect(@Nonnull String url) throws IOException {
+    public void sendRedirect(@NonNull String url) throws IOException {
         // WebSphere doesn't apparently handle relative URLs, so
         // to be safe, always resolve relative URLs to absolute URLs by ourselves.
         // see http://www.nabble.com/Hudson%3A-1.262%3A-Broken-link-using-update-manager-to21067157.html
@@ -150,13 +150,13 @@ public void sendRedirect(@Nonnull String url) throws IOException {
         super.sendRedirect(base);
     }
 
-    public void sendRedirect2(@Nonnull String url) throws IOException {
+    public void sendRedirect2(@NonNull String url) throws IOException {
         // Tomcat doesn't encode URL (servlet spec isn't very clear on it)
         // so do the encoding by ourselves
         sendRedirect(encode(url));
     }
 
-    public void sendRedirect(int statusCode, @Nonnull String url) throws IOException {
+    public void sendRedirect(int statusCode, @NonNull String url) throws IOException {
         if (statusCode==SC_MOVED_TEMPORARILY) {
             sendRedirect(url);  // to be safe, let the servlet container handles this default case
             return;
@@ -197,7 +197,7 @@ public void sendRedirect(int statusCode, @Nonnull String url) throws IOException
     }
 
     @SuppressFBWarnings(value = "HTTP_RESPONSE_SPLITTING", justification = "Already encoded and handled.")
-    private void setLocation(@Nonnull String url) {
+    private void setLocation(@NonNull String url) {
         setHeader("Location",url);
     }
 
@@ -396,7 +396,7 @@ private void copyAndClose(InputStream in, OutputStream out) throws IOException {
     /**
      * Escapes non-ASCII characters.
      */
-    public static @Nonnull String encode(@Nonnull String s) {
+    public static @NonNull String encode(@NonNull String s) {
         try {
             boolean escaped = false;
 

diff --git a/core/src/main/java/org/kohsuke/stapler/ScriptExecutor.java b/core/src/main/java/org/kohsuke/stapler/ScriptExecutor.java
@@ -24,8 +24,8 @@
 
 package org.kohsuke.stapler;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
  * Execution strategy for handling views written in other scripting languages.
@@ -38,5 +38,5 @@ public interface ScriptExecutor<S> {
     /**
      * Executes the given script on the given node and request, rendering output to the given response.
      */
-    void execute(@Nonnull StaplerRequest req, @Nonnull StaplerResponse rsp, @Nonnull S script, @CheckForNull Object it) throws Exception;
+    void execute(@NonNull StaplerRequest req, @NonNull StaplerResponse rsp, @NonNull S script, @CheckForNull Object it) throws Exception;
 }
diff --git a/core/src/main/java/org/kohsuke/stapler/ScriptRequestDispatcher.java b/core/src/main/java/org/kohsuke/stapler/ScriptRequestDispatcher.java
@@ -26,8 +26,8 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import javax.servlet.RequestDispatcher;
 import javax.servlet.ServletException;
 import javax.servlet.ServletRequest;
@@ -47,9 +47,9 @@ class ScriptRequestDispatcher<S> implements RequestDispatcher {
 
     private static final Logger LOGGER = Logger.getLogger(ScriptRequestDispatcher.class.getName());
 
-    @CheckForNull static <S> ScriptRequestDispatcher<S> newRequestDispatcher(@Nonnull AbstractTearOff<?, ? extends S, ?> scriptLoader,
-                                                                             @Nonnull ScriptExecutor<? super S> scriptExecutor,
-                                                                             @Nonnull String viewName,
+    @CheckForNull static <S> ScriptRequestDispatcher<S> newRequestDispatcher(@NonNull AbstractTearOff<?, ? extends S, ?> scriptLoader,
+                                                                             @NonNull ScriptExecutor<? super S> scriptExecutor,
+                                                                             @NonNull String viewName,
                                                                              @CheckForNull Object node) {
         S script;
         try {
@@ -64,16 +64,16 @@ class ScriptRequestDispatcher<S> implements RequestDispatcher {
         return new ScriptRequestDispatcher<>(scriptLoader.getDefaultScriptExtension(), scriptExecutor, viewName, script, node);
     }
 
-    private final @Nonnull String defaultScriptExtension;
-    private final @Nonnull ScriptExecutor<? super S> scriptExecutor;
-    private final @Nonnull String viewName;
-    private final @Nonnull S script;
+    private final @NonNull String defaultScriptExtension;
+    private final @NonNull ScriptExecutor<? super S> scriptExecutor;
+    private final @NonNull String viewName;
+    private final @NonNull S script;
     private final @CheckForNull Object node;
 
-    private ScriptRequestDispatcher(@Nonnull String defaultScriptExtension,
-                                    @Nonnull ScriptExecutor<? super S> scriptExecutor,
-                                    @Nonnull String viewName,
-                                    @Nonnull S script,
+    private ScriptRequestDispatcher(@NonNull String defaultScriptExtension,
+                                    @NonNull ScriptExecutor<? super S> scriptExecutor,
+                                    @NonNull String viewName,
+                                    @NonNull S script,
                                     @CheckForNull Object node) {
         this.defaultScriptExtension = defaultScriptExtension;
         this.scriptExecutor = scriptExecutor;

diff --git a/core/src/main/java/org/kohsuke/stapler/StaplerResponse.java b/core/src/main/java/org/kohsuke/stapler/StaplerResponse.java
@@ -30,7 +30,7 @@
 import org.kohsuke.stapler.export.Model;
 import org.kohsuke.stapler.export.NamedPathPruner;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
@@ -74,12 +74,12 @@ public interface StaplerResponse extends HttpServletResponse {
      * Works like {@link #sendRedirect(String)} except that this method
      * escapes the URL.
      */
-    void sendRedirect2(@Nonnull String url) throws IOException;
+    void sendRedirect2(@NonNull String url) throws IOException;
 
     /**
      * Works like {@link #sendRedirect2(String)} but allows the caller to specify the HTTP status code.
      */
-    void sendRedirect(int statusCore, @Nonnull String url) throws IOException;
+    void sendRedirect(int statusCore, @NonNull String url) throws IOException;
 
     /**
      * Serves a static resource.

diff --git a/core/src/main/java/org/kohsuke/stapler/StaplerResponseWrapper.java b/core/src/main/java/org/kohsuke/stapler/StaplerResponseWrapper.java
@@ -4,7 +4,7 @@
 import org.kohsuke.stapler.export.ExportConfig;
 import org.kohsuke.stapler.export.Flavor;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import javax.servlet.ServletException;
 import javax.servlet.ServletOutputStream;
 import javax.servlet.http.Cookie;
@@ -35,7 +35,7 @@ public StaplerResponseWrapper(StaplerResponse wrapped) {
     /**
      * Returns the wrapped instance
      */
-    @Nonnull
+    @NonNull
     public StaplerResponse getWrapped() {
         return wrapped;
     }

diff --git a/core/src/main/java/org/kohsuke/stapler/export/ClassAttributeBehaviour.java b/core/src/main/java/org/kohsuke/stapler/export/ClassAttributeBehaviour.java
@@ -2,7 +2,7 @@
 
 import org.jvnet.tiger_types.Types;
 
-import javax.annotation.Nullable;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import java.lang.reflect.Type;
 
 /**