Use spotbugs annotations and added some missing NonNull annotations (#…

…307)
jenkinsci · Oct 1, 2021 · 763adb5 · 763adb5
1 parent a0c40e4
commit 763adb5
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 14 deletions.
diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMAgent.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMAgent.java
@@ -22,6 +22,9 @@
 import com.microsoft.azure.vmagent.util.AzureUtil;
 import com.microsoft.azure.vmagent.util.CleanUpAction;
 import com.microsoft.azure.vmagent.util.Constants;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import hudson.Extension;
 import hudson.model.Computer;
 import hudson.model.Descriptor.FormException;
@@ -48,8 +51,6 @@
 import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.interceptor.RequirePOST;
 
-import javax.annotation.CheckForNull;
-import javax.annotation.Nullable;
 import java.io.IOException;
 import java.io.PrintStream;
 import java.io.ByteArrayInputStream;
@@ -744,7 +745,7 @@ public ProvisioningActivity.Id getId() {
     @Extension
     public static final class AzureVMAgentDescriptor extends SlaveDescriptor {
 
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return Constants.AZURE_VM_AGENT_CLOUD_DISPLAY_NAME;
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMAgentPostBuildAction.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMAgentPostBuildAction.java
@@ -20,6 +20,7 @@
 import java.io.IOException;
 import java.util.logging.Logger;
 
+import edu.umd.cs.findbugs.annotations.NonNull;
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import hudson.Extension;
@@ -119,7 +120,7 @@ public ListBoxModel doFillAgentPostBuildActionItems() {
             return model;
         }
 
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return Messages.Azure_Agent_Post_Build_Action();
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMAgentTemplate.java
@@ -38,6 +38,7 @@
 import com.microsoft.azure.vmagent.util.AzureUtil;
 import com.microsoft.azure.vmagent.util.Constants;
 import com.microsoft.azure.vmagent.util.FailureStage;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import hudson.RelativePath;
 import hudson.Util;
@@ -1308,7 +1309,7 @@ public List<String> verifyTemplate() throws Exception {
     @Extension
     public static final class DescriptorImpl extends Descriptor<AzureVMAgentTemplate> {
 
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return "";
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMCloud.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMCloud.java
@@ -36,6 +36,7 @@
 import com.microsoft.azure.vmagent.util.Constants;
 import com.microsoft.azure.vmagent.util.FailureStage;
 import com.microsoft.azure.vmagent.util.PoolLock;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import hudson.init.Initializer;
 import hudson.logging.LogRecorder;
@@ -1012,7 +1013,7 @@ public static void addLogRecorder(Jenkins h) throws IOException {
             }
         }
 
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return Constants.AZURE_CLOUD_DISPLAY_NAME;
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMCloudOnceRetentionStrategy.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMCloudOnceRetentionStrategy.java
@@ -101,7 +101,7 @@ public DescriptorImpl getDescriptor() {
     public static final DescriptorImpl DESCRIPTOR = new AzureVMCloudOnceRetentionStrategy.DescriptorImpl();
 
     public static class DescriptorImpl extends Descriptor<RetentionStrategy<?>> {
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return "Azure VM Once Retention Strategy";
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMCloudPoolRetentionStrategy.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMCloudPoolRetentionStrategy.java
@@ -181,7 +181,7 @@ public DescriptorImpl getDescriptor() {
 
     public static class DescriptorImpl extends Descriptor<RetentionStrategy<?>> {
 
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return "Azure VM Pool Retention Strategy";
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMCloudRetensionStrategy.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMCloudRetensionStrategy.java
@@ -56,7 +56,7 @@ public AzureVMCloudRetensionStrategy(int idleTerminationMinutes) {
      * @return Number of minutes before node will be checked again.
      */
     @Override
-    public long check(AzureVMComputer agentNode) {
+    public long check(@NonNull AzureVMComputer agentNode) {
         return check(agentNode, new ExecutionEngine());
     }
 
@@ -163,7 +163,7 @@ public DescriptorImpl getDescriptor() {
 
     @Symbol("azureVMCloudRetentionStrategy") //  TODO evaluate impact of renaming class to fix the default symbol name
     public static class DescriptorImpl extends Descriptor<RetentionStrategy<?>> {
-        @Override
+        @Override @NonNull
         public String getDisplayName() {
             return "Azure VM Idle Retention Strategy";
         }

diff --git a/src/main/java/com/microsoft/azure/vmagent/AzureVMComputer.java b/src/main/java/com/microsoft/azure/vmagent/AzureVMComputer.java
@@ -19,6 +19,7 @@
 import com.microsoft.azure.vmagent.exceptions.AzureCloudException;
 import com.microsoft.azure.vmagent.retry.NoRetryStrategy;
 import com.microsoft.azure.vmagent.util.ExecutionEngine;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import hudson.slaves.AbstractCloudComputer;
 import hudson.slaves.OfflineCause;
 import org.jenkinsci.plugins.cloudstats.ProvisioningActivity;
@@ -28,7 +29,6 @@
 import org.kohsuke.stapler.HttpRedirect;
 import org.kohsuke.stapler.HttpResponse;
 
-import javax.annotation.Nullable;
 import java.util.concurrent.Callable;
 import java.util.logging.Level;
 import java.util.logging.Logger;

diff --git a/src/main/java/com/microsoft/azure/vmagent/util/AzureClientHolder.java b/src/main/java/com/microsoft/azure/vmagent/util/AzureClientHolder.java
@@ -2,10 +2,9 @@
 
 import com.azure.resourcemanager.AzureResourceManager;
 import com.microsoft.azure.vmagent.AzureVMManagementServiceDelegate;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import org.apache.commons.lang.StringUtils;
 
-import javax.annotation.Nonnull;
-
 /**
  * The Azure client cache holder for the configuration page, where the VMCloud objects may not exist.
  */
@@ -16,7 +15,7 @@ public final class AzureClientHolder {
     private AzureClientHolder() {
     }
 
-    @Nonnull
+    @NonNull
     public static synchronized AzureResourceManager get(String credentialId) {
         if (credentialId == null) {
             throw new NullPointerException("credentialId is null!");