Merge pull request #131 from basil/jsr305

EOL JSR 305

Author: jglick

src/main/java/org/jenkinsci/plugins/docker/commons/DockerImageExtractor.java

@@ -27,7 +27,7 @@
 import hudson.ExtensionPoint;
 import hudson.model.Job;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import java.util.Collection;
 import java.util.Set;
 import java.util.TreeSet;
@@ -45,8 +45,8 @@ public abstract class DockerImageExtractor implements ExtensionPoint {
      * @param job the job being queried.
      * @return a collection of names, or an empty collection.
      */
-    @Nonnull
-    public abstract Collection<String> getDockerImagesUsedByJob(@Nonnull Job<?,?> job);
+    @NonNull
+    public abstract Collection<String> getDockerImagesUsedByJob(@NonNull Job<?,?> job);
 
     /**
      * Provides a set of repository names {@code namespace/name} that the job uses as seen by all the declared {@link DockerImageExtractor}s.
@@ -55,8 +55,8 @@ public abstract class DockerImageExtractor implements ExtensionPoint {
      * @param job the job being queried.
      * @return a set of names, or an empty set.
      */
-    @Nonnull
-    public static Set<String> getDockerImagesUsedByJobFromAll(@Nonnull Job<?,?> job) {
+    @NonNull
+    public static Set<String> getDockerImagesUsedByJobFromAll(@NonNull Job<?,?> job) {
         Set<String> names = new TreeSet<String>();
         for (DockerImageExtractor extractor : ExtensionList.lookup(DockerImageExtractor.class)) {
             names.addAll(extractor.getDockerImagesUsedByJob(job));

src/main/java/org/jenkinsci/plugins/docker/commons/fingerprint/ContainerRecord.java

@@ -25,7 +25,7 @@
 
 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import java.io.Serializable;
 import java.util.Collections;
 import java.util.HashMap;
@@ -53,7 +53,7 @@ public class ContainerRecord implements Serializable {
     private final long created;
     private final Map<String,String> tags;
 
-    public ContainerRecord(@Nonnull String host, @Nonnull String containerId, @Nonnull String imageId, @Nonnull String containerName, long created, @Nonnull Map<String,String> tags) {
+    public ContainerRecord(@NonNull String host, @NonNull String containerId, @NonNull String imageId, @NonNull String containerName, long created, @NonNull Map<String,String> tags) {
         this.host = host;
         this.containerId = containerId;
         this.imageId = imageId;
@@ -88,7 +88,7 @@ public String getImageId() {
      * Set the image ID of the image from which this container was started.
      * @param imageId The image ID of the image from which this container was started.
      */
-    public void setImageId(@Nonnull String imageId) {
+    public void setImageId(@NonNull String imageId) {
         this.imageId = imageId;
     }
 

src/main/java/org/jenkinsci/plugins/docker/commons/fingerprint/DockerAncestorFingerprintFacet.java

@@ -26,7 +26,7 @@
 import hudson.model.Fingerprint;
 import java.util.Set;
 import java.util.TreeSet;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
  * Facet representing the fact that this Docker image was derived from another.
@@ -43,7 +43,7 @@ public class DockerAncestorFingerprintFacet extends DockerRunPtrFingerprintFacet
         super(fingerprint, timestamp, imageId);
     }
 
-    synchronized void addAncestorImageId(@Nonnull String id) {
+    synchronized void addAncestorImageId(@NonNull String id) {
         ancestorImageIds.add(id);
     }
 
@@ -55,7 +55,7 @@ synchronized void addAncestorImageId(@Nonnull String id) {
      * The set may be empty in case you built a base image ({@code FROM scratch}), in which case there is no ID for the ancestor.
      * @return a set of 64-digit IDs, typically a singleton
      */
-    public synchronized @Nonnull Set<String> getAncestorImageIds() {
+    public synchronized @NonNull Set<String> getAncestorImageIds() {
         return new TreeSet<String>(ancestorImageIds);
     }
 

src/main/java/org/jenkinsci/plugins/docker/commons/fingerprint/DockerDescendantFingerprintFacet.java

@@ -26,7 +26,7 @@
 import hudson.model.Fingerprint;
 import java.util.Set;
 import java.util.TreeSet;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 
 /**
  * Facet representing the fact that some Docker image was derived from this one.
@@ -43,15 +43,15 @@ public class DockerDescendantFingerprintFacet extends DockerRunPtrFingerprintFac
         super(fingerprint, timestamp, imageId);
     }
 
-    synchronized void addDescendantImageId(@Nonnull String id) {
+    synchronized void addDescendantImageId(@NonNull String id) {
         descendantImageIds.add(id);
     }
 
     /**
      * Gets the descendant images built from this image.
      * @return a set of 64-digit IDs, never empty
      */
-    public synchronized @Nonnull Set<String> getDescendantImageIds() {
+    public synchronized @NonNull Set<String> getDescendantImageIds() {
         return new TreeSet<String>(descendantImageIds);
     }
 

src/main/java/org/jenkinsci/plugins/docker/commons/fingerprint/DockerFingerprintAction.java

@@ -31,7 +31,7 @@
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Set;
-import javax.annotation.CheckForNull;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import jenkins.model.FingerprintFacet;
 import jenkins.model.RunAction2;
 import org.jenkins.ui.icon.IconSpec;

src/main/java/org/jenkinsci/plugins/docker/commons/fingerprint/DockerFingerprints.java

@@ -35,8 +35,8 @@
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-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.FingerprintFacet;
 import org.apache.commons.lang.StringUtils;
 
@@ -60,7 +60,7 @@ private DockerFingerprints() {} // no instantiation
      * @return 32-char fingerprint hash
      * @throws IllegalArgumentException Invalid ID
      */
-    public static @Nonnull String getFingerprintHash(@Nonnull String id) {
+    public static @NonNull String getFingerprintHash(@NonNull String id) {
 
         // Remove the "sha256:" prefix, if it exists
         if (id.indexOf("sha256:") == 0) {
@@ -79,11 +79,11 @@ private DockerFingerprints() {} // no instantiation
      * @return Created fingerprint or null if it is not found
      * @throws IOException Fingerprint loading error
      */
-    public static @CheckForNull Fingerprint of(@Nonnull String id) throws IOException {
+    public static @CheckForNull Fingerprint of(@NonNull String id) throws IOException {
         return Jenkins.get().getFingerprintMap().get(getFingerprintHash(id));
     }
 
-    private static @CheckForNull Fingerprint ofNoException(@Nonnull String id) {
+    private static @CheckForNull Fingerprint ofNoException(@NonNull String id) {
         try {
             return of(id);
         } catch (IOException ex) { // The error is not a hazard in CheckForNull logic
@@ -95,7 +95,7 @@ private DockerFingerprints() {} // no instantiation
     /**
      * @deprecated Use {@link #forImage(hudson.model.Run, java.lang.String, java.lang.String)}
      */
-    public static @Nonnull Fingerprint forImage(@CheckForNull Run<?,?> run, @Nonnull String id) throws IOException {
+    public static @NonNull Fingerprint forImage(@CheckForNull Run<?,?> run, @NonNull String id) throws IOException {
         return forImage(run, id, null);
     }
 
@@ -109,16 +109,16 @@ private DockerFingerprints() {} // no instantiation
      * @throws IOException Fingerprint load/save error
      * @since TODO
      */
-    public static @Nonnull Fingerprint forImage(@CheckForNull Run<?,?> run, 
-            @Nonnull String id, @CheckForNull String name) throws IOException {
+    public static @NonNull Fingerprint forImage(@CheckForNull Run<?,?> run, 
+            @NonNull String id, @CheckForNull String name) throws IOException {
         return forDockerInstance(run, id, name, "Docker image ");
     }
 
     /**
      * @deprecated Use {@link #forContainer(hudson.model.Run, java.lang.String, java.lang.String)}
      */
     @Deprecated
-    public static @Nonnull Fingerprint forContainer(@CheckForNull Run<?,?> run, @Nonnull String id) throws IOException {
+    public static @NonNull Fingerprint forContainer(@CheckForNull Run<?,?> run, @NonNull String id) throws IOException {
         return forContainer(run, id, null);
     }
 
@@ -132,13 +132,13 @@ private DockerFingerprints() {} // no instantiation
      * @throws IOException Fingerprint load/save error
      * @since TODO
      */
-    public static @Nonnull Fingerprint forContainer(@CheckForNull Run<?,?> run, 
-            @Nonnull String id, @CheckForNull String name) throws IOException {
+    public static @NonNull Fingerprint forContainer(@CheckForNull Run<?,?> run, 
+            @NonNull String id, @CheckForNull String name) throws IOException {
         return forDockerInstance(run, id, name, "Docker container ");
     }
 
-    private static @Nonnull Fingerprint forDockerInstance(@CheckForNull Run<?,?> run, 
-            @Nonnull String id, @CheckForNull String name, @Nonnull String prefix) throws IOException {
+    private static @NonNull Fingerprint forDockerInstance(@CheckForNull Run<?,?> run, 
+            @NonNull String id, @CheckForNull String name, @NonNull String prefix) throws IOException {
         final String imageName = prefix + (StringUtils.isNotBlank(name) ? name : id);
         return Jenkins.get().getFingerprintMap().getOrCreate(run, imageName, getFingerprintHash(id));
     }
@@ -154,7 +154,7 @@ private DockerFingerprints() {} // no instantiation
      */
     public static @CheckForNull @SuppressWarnings("unchecked")
             <TFacet extends FingerprintFacet> TFacet getFacet
-            (@Nonnull String id, @Nonnull Class<TFacet> facetClass) { 
+            (@NonNull String id, @NonNull Class<TFacet> facetClass) { 
         final Fingerprint fp = ofNoException(id); 
         return (fp != null) ? getFacet(fp, facetClass) : null;
     }
@@ -168,8 +168,8 @@ private DockerFingerprints() {} // no instantiation
      * @return First matching facet. Null may be returned if the loading fails
      */
     @SuppressWarnings("unchecked")
-    public static @Nonnull <TFacet extends FingerprintFacet> Collection<TFacet> getFacets
-            (@Nonnull String id, @Nonnull Class<TFacet> facetClass) { 
+    public static @NonNull <TFacet extends FingerprintFacet> Collection<TFacet> getFacets
+            (@NonNull String id, @NonNull Class<TFacet> facetClass) { 
         final Fingerprint fp = ofNoException(id);
         return (fp != null) ? getFacets(fp, facetClass) : Collections.<TFacet>emptySet();
     }        
@@ -184,7 +184,7 @@ private DockerFingerprints() {} // no instantiation
      */
      @SuppressWarnings("unchecked")
     public static @CheckForNull <TFacet extends FingerprintFacet> TFacet getFacet
-            (@Nonnull Fingerprint fingerprint, @Nonnull Class<TFacet> facetClass) {  
+            (@NonNull Fingerprint fingerprint, @NonNull Class<TFacet> facetClass) {  
         for ( FingerprintFacet facet : fingerprint.getFacets()) {
             if (facetClass.isAssignableFrom(facet.getClass())) {
                 return (TFacet)facet;
@@ -201,9 +201,9 @@ private DockerFingerprints() {} // no instantiation
      * @param facetClass Facet class to be retrieved
      * @return All found facets
      */
-    public static @Nonnull @SuppressWarnings("unchecked")
+    public static @NonNull @SuppressWarnings("unchecked")
             <TFacet extends FingerprintFacet> Collection<TFacet> getFacets
-            (@Nonnull Fingerprint fingerprint, @Nonnull Class<TFacet> facetClass) { 
+            (@NonNull Fingerprint fingerprint, @NonNull Class<TFacet> facetClass) { 
         final List<TFacet> res = new LinkedList<TFacet>();
         for ( FingerprintFacet facet : fingerprint.getFacets()) {
             if (facetClass.isAssignableFrom(facet.getClass())) {
@@ -216,7 +216,7 @@ private DockerFingerprints() {} // no instantiation
     /**
      * Adds a new {@link ContainerRecord} for the specified image, creating necessary intermediate objects as it goes.
      */
-    public static void addRunFacet(@Nonnull ContainerRecord record, @Nonnull Run<?,?> run) throws IOException {
+    public static void addRunFacet(@NonNull ContainerRecord record, @NonNull Run<?,?> run) throws IOException {
         String imageId = record.getImageId();
         Fingerprint f = forImage(run, imageId);
         synchronized (f) {
@@ -251,7 +251,7 @@ public static void addRunFacet(@Nonnull ContainerRecord record, @Nonnull Run<?,?
      * @param descendantImageId the ID of the image which was built
      * @param run the build in which the image building occurred
      */
-    public static void addFromFacet(@CheckForNull String ancestorImageId, @Nonnull String descendantImageId, @Nonnull Run<?,?> run) throws IOException {
+    public static void addFromFacet(@CheckForNull String ancestorImageId, @NonNull String descendantImageId, @NonNull Run<?,?> run) throws IOException {
         long timestamp = System.currentTimeMillis();
         if (ancestorImageId != null) {
             Fingerprint f = forImage(run, ancestorImageId);

src/main/java/org/jenkinsci/plugins/docker/commons/impl/CompositeKeyMaterialFactory.java

@@ -30,7 +30,7 @@
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import java.io.IOException;
 import java.io.Serializable;
 
@@ -50,7 +50,7 @@ public CompositeKeyMaterialFactory(KeyMaterialFactory... factories) {
     }
 
     @Override
-    public synchronized KeyMaterialFactory contextualize(@Nonnull KeyMaterialContext context) {
+    public synchronized KeyMaterialFactory contextualize(@NonNull KeyMaterialContext context) {
         KeyMaterialFactory contextualized = super.contextualize(context);
         assert contextualized == this;
         for (KeyMaterialFactory factory : factories) {

src/main/java/org/jenkinsci/plugins/docker/commons/tools/DockerTool.java

@@ -40,9 +40,9 @@
 import hudson.util.ArgumentListBuilder;
 import java.io.IOException;
 import java.util.List;
-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;
 import jenkins.model.Jenkins;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -72,7 +72,7 @@ public class DockerTool extends ToolInstallation implements EnvironmentSpecific<
      * @param env optionally, environment variables to use when expanding the home directory
      * @return {@code docker} or an absolute path
      */
-    public static @Nonnull String getExecutable(@CheckForNull String name, @CheckForNull Node node, @Nullable TaskListener listener, @CheckForNull EnvVars env) throws IOException, InterruptedException {
+    public static @NonNull String getExecutable(@CheckForNull String name, @CheckForNull Node node, @Nullable TaskListener listener, @CheckForNull EnvVars env) throws IOException, InterruptedException {
         if (name != null) {
             for (DockerTool tool : Jenkins.get().getDescriptorByType(DescriptorImpl.class).getInstallations()) {
                 if (tool.getName().equals(name)) {

src/main/java/org/jenkinsci/plugins/docker/commons/tools/DockerToolInstaller.java

@@ -43,7 +43,7 @@
 import java.net.URLConnection;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
-import javax.annotation.Nonnull;
+import edu.umd.cs.findbugs.annotations.NonNull;
 import jenkins.security.MasterToSlaveCallable;
 import org.jenkinsci.Symbol;
 import org.kohsuke.stapler.DataBoundConstructor;
@@ -66,7 +66,7 @@ public String getVersion() {
     }
 
     @Override
-    public FilePath performInstallation(ToolInstallation toolInstallation, @Nonnull Node node, TaskListener listener) throws IOException, InterruptedException {
+    public FilePath performInstallation(ToolInstallation toolInstallation, @NonNull Node node, TaskListener listener) throws IOException, InterruptedException {
 
         VirtualChannel nodeChannel = node.getChannel();
         if (nodeChannel == null) {