Merge pull request #79 from basil/jsr305

EOL JSR 305

Author: jglick

src/main/java/org/jenkinsci/plugins/workflow/steps/AbstractStepImpl.java

@@ -3,7 +3,7 @@
 import com.google.inject.Injector;
 import jenkins.model.Jenkins;
 
-import javax.annotation.Nullable;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import javax.inject.Inject;
 
 /**

src/main/java/org/jenkinsci/plugins/workflow/steps/AbstractSynchronousNonBlockingStepExecution.java

@@ -3,7 +3,7 @@
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import hudson.security.ACL;
 import java.util.concurrent.Future;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import jenkins.model.Jenkins;
 import jenkins.security.NotReallyRoleSensitiveCallable;
 import org.acegisecurity.Authentication;
@@ -70,7 +70,7 @@ public void onResume() {
         getContext().onFailure(new SynchronousResumeNotSupportedException());
     }
 
-    @Override public @Nonnull String getStatus() {
+    @Override public @NonNull String getStatus() {
         if (threadName != null) {
             return "running in thread: " + threadName;
         } else {

src/main/java/org/jenkinsci/plugins/workflow/steps/BodyInvoker.java

@@ -36,8 +36,8 @@
 
 import java.util.Arrays;
 import java.util.Collection;
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
  * Builder pattern for controlling how to execute a body block of a {@link Step}.
@@ -85,7 +85,7 @@ public BodyInvoker withContexts(Collection<?> overrides) {
      *
      * @return this object
      */
-    public abstract BodyInvoker withDisplayName(@Nonnull String name);
+    public abstract BodyInvoker withDisplayName(@NonNull String name);
 
     /**
      * Registers a callback that tracks the progress of the body execution.
@@ -115,7 +115,7 @@ public final BodyInvoker withCallback(FutureCallback<Object> callback) {
      * @return a merge of the two, or just yours if there was no original
      * @see #withContext
      */
-    public static ConsoleLogFilter mergeConsoleLogFilters(@CheckForNull ConsoleLogFilter original, @Nonnull ConsoleLogFilter subsequent) {
+    public static ConsoleLogFilter mergeConsoleLogFilters(@CheckForNull ConsoleLogFilter original, @NonNull ConsoleLogFilter subsequent) {
         if (original == null) {
             return subsequent;
         }
@@ -141,7 +141,7 @@ private static final class MergedFilter extends ConsoleLogFilter implements Seri
      * @return a merge of the two, or just yours if there was no original
      * @see #withContext
      */
-    public static LauncherDecorator mergeLauncherDecorators(@CheckForNull LauncherDecorator original, @Nonnull LauncherDecorator subsequent) {
+    public static LauncherDecorator mergeLauncherDecorators(@CheckForNull LauncherDecorator original, @NonNull LauncherDecorator subsequent) {
         if (original == null) {
             return subsequent;
         }

src/main/java/org/jenkinsci/plugins/workflow/steps/ContextParameterModule.java

@@ -8,7 +8,7 @@
 import com.google.inject.spi.TypeEncounter;
 import com.google.inject.spi.TypeListener;
 
-import javax.annotation.Nullable;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import java.io.IOException;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;

src/main/java/org/jenkinsci/plugins/workflow/steps/DynamicContext.java

@@ -26,9 +26,9 @@
 
 import hudson.ExtensionPoint;
 import java.io.IOException;
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import edu.umd.cs.findbugs.annotations.Nullable;
 
 /**
  * Allows {@link StepContext#get} to provide a dynamically computed value.
@@ -82,7 +82,7 @@ abstract class Typed<T> implements DynamicContext {
         /**
          * A type token.
          */
-        protected abstract @Nonnull Class<T> type();
+        protected abstract @NonNull Class<T> type();
 
         /**
          * As {@link #get(Class, DelegatedContext)}.

src/main/java/org/jenkinsci/plugins/workflow/steps/EnvironmentExpander.java

@@ -37,8 +37,8 @@
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
  * Interface destined for {@link StepContext#get} instead of raw {@link EnvVars}.
@@ -50,15 +50,15 @@ public abstract class EnvironmentExpander implements Serializable {
      * May add environment variables to a context.
      * @param env an original set of environment variables
      */
-    public abstract void expand(@Nonnull EnvVars env) throws IOException, InterruptedException;
+    public abstract void expand(@NonNull EnvVars env) throws IOException, InterruptedException;
 
     /**
      * Get the names of environment variables known to contain sensitive values, such as secrets, in the current context.
      * Should be overridden by subclasses that bind secret values to environment variables.
      *
      * @return a set of environment variables known to contain sensitive values
      */
-    public @Nonnull Set<String> getSensitiveVariables() {
+    public @NonNull Set<String> getSensitiveVariables() {
         return Collections.emptySet();
     }
 
@@ -69,15 +69,15 @@ public abstract class EnvironmentExpander implements Serializable {
      * @param env A non-null map of string keys and string values.
      * @return An expander which will provide the given map.
      */
-    public static EnvironmentExpander constant(@Nonnull Map<String,String> env) {
+    public static EnvironmentExpander constant(@NonNull Map<String,String> env) {
         return new ConstantEnvironmentExpander(env);
     }
 
     private static class ConstantEnvironmentExpander extends EnvironmentExpander {
         private static final long serialVersionUID = 1;
         private final Map<String,String> envMap;
 
-        ConstantEnvironmentExpander(@Nonnull Map<String,String> envMap) {
+        ConstantEnvironmentExpander(@NonNull Map<String,String> envMap) {
             this.envMap = new HashMap<>();
             this.envMap.putAll(envMap);
         }
@@ -93,15 +93,15 @@ private static class ConstantEnvironmentExpander extends EnvironmentExpander {
      * @param subsequent what you are adding
      * @return an expander which runs them both in that sequence (or, as a convenience, just {@code subsequent} in case {@code original} is null)
      */
-    public static EnvironmentExpander merge(@CheckForNull EnvironmentExpander original, @Nonnull EnvironmentExpander subsequent) {
+    public static EnvironmentExpander merge(@CheckForNull EnvironmentExpander original, @NonNull EnvironmentExpander subsequent) {
         if (original == null) {
             return subsequent;
         }
         return new MergedEnvironmentExpander(original, subsequent);
     }
     private static class MergedEnvironmentExpander extends EnvironmentExpander {
         private static final long serialVersionUID = 1;
-        private final @Nonnull EnvironmentExpander original, subsequent;
+        private final @NonNull EnvironmentExpander original, subsequent;
         MergedEnvironmentExpander(EnvironmentExpander original, EnvironmentExpander subsequent) {
             this.original = original;
             this.subsequent = subsequent;
@@ -131,7 +131,7 @@ public Set<String> getSensitiveVariables() {
      * @deprecated Use {@link #getEffectiveEnvironment(EnvVars, EnvVars, EnvironmentExpander, StepContext, TaskListener)} to allow {@link StepEnvironmentContributor}s to run.
      */
     @Deprecated
-    public static @Nonnull EnvVars getEffectiveEnvironment(@Nonnull EnvVars customEnvironment, @CheckForNull EnvVars contextualEnvironment, @CheckForNull EnvironmentExpander expander) throws IOException, InterruptedException {
+    public static @NonNull EnvVars getEffectiveEnvironment(@NonNull EnvVars customEnvironment, @CheckForNull EnvVars contextualEnvironment, @CheckForNull EnvironmentExpander expander) throws IOException, InterruptedException {
         return getEffectiveEnvironment(customEnvironment, contextualEnvironment, expander, null, TaskListener.NULL);
     }
 
@@ -152,7 +152,7 @@ public Set<String> getSensitiveVariables() {
      * @param listener Connected to the build console. Can be used to report errors.
      * @return the effective environment
      */
-    public static @Nonnull EnvVars getEffectiveEnvironment(@Nonnull EnvVars customEnvironment, @CheckForNull EnvVars contextualEnvironment, @CheckForNull EnvironmentExpander expander, @CheckForNull StepContext stepContext, @Nonnull TaskListener listener) throws IOException, InterruptedException {
+    public static @NonNull EnvVars getEffectiveEnvironment(@NonNull EnvVars customEnvironment, @CheckForNull EnvVars contextualEnvironment, @CheckForNull EnvironmentExpander expander, @CheckForNull StepContext stepContext, @NonNull TaskListener listener) throws IOException, InterruptedException {
         EnvVars env;
         if (contextualEnvironment != null) {
             env = new EnvVars(contextualEnvironment);

src/main/java/org/jenkinsci/plugins/workflow/steps/FlowInterruptedException.java

@@ -36,8 +36,8 @@
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Set;
-import javax.annotation.CheckForNull;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import jenkins.model.CauseOfInterruption;
 import jenkins.model.InterruptedBuildAction;
 
@@ -55,8 +55,8 @@ public final class FlowInterruptedException extends InterruptedException {
 
     private static final long serialVersionUID = 630482382622970136L;
 
-    private final @Nonnull Result result;
-    private final @Nonnull List<CauseOfInterruption> causes;
+    private final @NonNull Result result;
+    private final @NonNull List<CauseOfInterruption> causes;
     /**
      * If true, this exception represents an actual build interruption, rather than a general error with a result and
      * no stack trace.
@@ -71,7 +71,7 @@ public final class FlowInterruptedException extends InterruptedException {
      * @param result the desired result for the flow, typically {@link Result#ABORTED}
      * @param causes any indications
      */
-    public FlowInterruptedException(@Nonnull Result result, @Nonnull CauseOfInterruption... causes) {
+    public FlowInterruptedException(@NonNull Result result, @NonNull CauseOfInterruption... causes) {
         this.result = result;
         this.causes = Arrays.asList(causes);
         this.actualInterruption = true;
@@ -83,17 +83,17 @@ public FlowInterruptedException(@Nonnull Result result, @Nonnull CauseOfInterrup
      * @param causes any indications
      * @param actualInterruption true if this is an actual build interruption (e.g. the user wants to abort the build)
      */
-    public FlowInterruptedException(@Nonnull Result result, boolean actualInterruption, @Nonnull CauseOfInterruption... causes) {
+    public FlowInterruptedException(@NonNull Result result, boolean actualInterruption, @NonNull CauseOfInterruption... causes) {
         this.result = result;
         this.causes = Arrays.asList(causes);
         this.actualInterruption = actualInterruption;
     }
 
-    public @Nonnull Result getResult() {
+    public @NonNull Result getResult() {
         return result;
     }
 
-    public @Nonnull List<CauseOfInterruption> getCauses() {
+    public @NonNull List<CauseOfInterruption> getCauses() {
         return causes;
     }
 
@@ -133,7 +133,7 @@ public void handle(Run<?,?> run, TaskListener listener) {
             print(t, run, listener);
         }
     }
-    private static void print(@CheckForNull Throwable t, Run<?,?> run, @Nonnull TaskListener listener) {
+    private static void print(@CheckForNull Throwable t, Run<?,?> run, @NonNull TaskListener listener) {
         if (t instanceof AbortException) {
             listener.getLogger().println(t.getMessage());
         } else if (t instanceof FlowInterruptedException) {

src/main/java/org/jenkinsci/plugins/workflow/steps/GeneralNonBlockingStepExecution.java

@@ -28,7 +28,7 @@
 import hudson.security.ACLContext;
 import java.util.concurrent.Callable;
 import java.util.concurrent.Future;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import jenkins.model.Jenkins;
 import org.acegisecurity.Authentication;
 
@@ -108,7 +108,7 @@ public void onResume() {
         }
     }
 
-    @Override public @Nonnull String getStatus() {
+    @Override public @NonNull String getStatus() {
         if (threadName != null) {
             return "running in thread: " + threadName;
         } else {

src/main/java/org/jenkinsci/plugins/workflow/steps/MissingContextVariableException.java

@@ -1,6 +1,6 @@
 package org.jenkinsci.plugins.workflow.steps;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
@@ -15,9 +15,9 @@
  * TODO: extend from AbortException if it's not final
  */
 public class MissingContextVariableException extends Exception {
-    private final @Nonnull Class<?> type;
+    private final @NonNull Class<?> type;
 
-    public MissingContextVariableException(@Nonnull Class<?> type) {
+    public MissingContextVariableException(@NonNull Class<?> type) {
         this.type = type;
     }
 
@@ -49,7 +49,7 @@ public Class<?> getType() {
      * decorates/modifies the existing context, so we check required context as well to
      * exclude them
      */
-    public @Nonnull List<StepDescriptor> getProviders() {
+    public @NonNull List<StepDescriptor> getProviders() {
         List<StepDescriptor> r = new ArrayList<>();
         for (StepDescriptor sd : StepDescriptor.all()) {
             if (isIn(sd.getProvidedContext()) && !isIn(sd.getRequiredContext()))

src/main/java/org/jenkinsci/plugins/workflow/steps/StepContext.java

@@ -35,7 +35,7 @@
 import hudson.model.Run;
 import hudson.model.TaskListener;
 
-import javax.annotation.Nullable;
+import edu.umd.cs.findbugs.annotations.Nullable;
 import java.io.IOException;
 import java.io.Serializable;