Skip to content

Commit b8660f8

Browse files
committed
Add missing annotations
1 parent 2f14004 commit b8660f8

File tree

11 files changed

+31
-17
lines changed

11 files changed

+31
-17
lines changed

src/main/java/org/jenkinsci/plugins/docker/workflow/AbstractEndpointStepExecution.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*/
2424
package org.jenkinsci.plugins.docker.workflow;
2525

26+
import edu.umd.cs.findbugs.annotations.NonNull;
2627
import hudson.EnvVars;
2728
import java.io.IOException;
2829
import java.util.logging.Level;
@@ -48,7 +49,7 @@ protected KeyMaterialFactory newKeyMaterialFactory() throws IOException, Interru
4849
throw new AssertionError();
4950
}
5051

51-
@Override public final void stop(Throwable cause) throws Exception {
52+
@Override public final void stop(@NonNull Throwable cause) throws Exception {
5253
// should not need to do anything special
5354
}
5455

src/main/java/org/jenkinsci/plugins/docker/workflow/DockerDSL.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*/
2424
package org.jenkinsci.plugins.docker.workflow;
2525

26+
import edu.umd.cs.findbugs.annotations.NonNull;
2627
import groovy.lang.Binding;
2728
import hudson.Extension;
2829
import org.jenkinsci.plugins.workflow.cps.CpsScript;
@@ -33,10 +34,12 @@
3334
*/
3435
@Extension public class DockerDSL extends GlobalVariable {
3536

37+
@NonNull
3638
@Override public String getName() {
3739
return "docker";
3840
}
3941

42+
@NonNull
4043
@Override public Object getValue(CpsScript script) throws Exception {
4144
Binding binding = script.getBinding();
4245
Object docker;

src/main/java/org/jenkinsci/plugins/docker/workflow/FromFingerprintStep.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
import java.util.Map;
2727

2828
import com.google.inject.Inject;
29+
import edu.umd.cs.findbugs.annotations.NonNull;
2930
import hudson.AbortException;
3031
import hudson.EnvVars;
3132
import hudson.Extension;
@@ -133,6 +134,7 @@ public DescriptorImpl() {
133134
return "dockerFingerprintFrom";
134135
}
135136

137+
@NonNull
136138
@Override public String getDisplayName() {
137139
return "Record trace of a Docker image used in FROM";
138140
}

src/main/java/org/jenkinsci/plugins/docker/workflow/ImageAction.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*/
2424
package org.jenkinsci.plugins.docker.workflow;
2525

26+
import edu.umd.cs.findbugs.annotations.NonNull;
2627
import hudson.BulkChange;
2728
import hudson.Extension;
2829
import hudson.model.InvisibleAction;
@@ -70,6 +71,7 @@ static void add(String image, Run<?,?> run) throws IOException {
7071

7172
@Extension public static final class ExtractorImpl extends DockerImageExtractor {
7273

74+
@NonNull
7375
@Override public Collection<String> getDockerImagesUsedByJob(Job<?,?> job) {
7476
Run<?,?> build = job.getLastCompletedBuild();
7577
if (build != null) {

src/main/java/org/jenkinsci/plugins/docker/workflow/RegistryEndpointStep.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
import java.util.Collections;
3939
import java.util.HashMap;
4040
import java.util.Map;
41+
import java.util.Objects;
4142
import java.util.Set;
4243
import java.util.TreeMap;
4344
import org.jenkinsci.plugins.docker.commons.credentials.DockerRegistryEndpoint;
@@ -57,14 +58,15 @@ public class RegistryEndpointStep extends Step {
5758
private @CheckForNull String toolName;
5859

5960
@DataBoundConstructor public RegistryEndpointStep(@NonNull DockerRegistryEndpoint registry) {
60-
assert registry != null;
61-
this.registry = registry;
61+
this.registry = Objects.requireNonNull(registry, "registry must not be null");;
6262
}
63-
63+
64+
@NonNull
6465
public DockerRegistryEndpoint getRegistry() {
6566
return registry;
6667
}
6768

69+
@CheckForNull
6870
public String getToolName() {
6971
return toolName;
7072
}
@@ -111,6 +113,7 @@ public static class Execution extends AbstractEndpointStepExecution {
111113
return "withDockerRegistry";
112114
}
113115

116+
@NonNull
114117
@Override public String getDisplayName() {
115118
return "Sets up Docker registry endpoint";
116119
}

src/main/java/org/jenkinsci/plugins/docker/workflow/RunFingerprintStep.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*/
2424
package org.jenkinsci.plugins.docker.workflow;
2525

26+
import edu.umd.cs.findbugs.annotations.NonNull;
2627
import org.jenkinsci.plugins.docker.workflow.client.DockerClient;
2728
import com.google.inject.Inject;
2829
import hudson.EnvVars;
@@ -98,6 +99,7 @@ public DescriptorImpl() {
9899
return "dockerFingerprintRun";
99100
}
100101

102+
@NonNull
101103
@Override public String getDisplayName() {
102104
return "Record trace of a Docker image run in a container";
103105
}

src/main/java/org/jenkinsci/plugins/docker/workflow/ServerEndpointStep.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
import hudson.FilePath;
3030
import hudson.model.Run;
3131
import java.io.IOException;
32+
import java.util.Objects;
3233
import java.util.Set;
3334
import org.jenkinsci.plugins.docker.commons.credentials.DockerServerEndpoint;
3435
import org.jenkinsci.plugins.docker.commons.credentials.KeyMaterialFactory;
@@ -43,10 +44,10 @@ public class ServerEndpointStep extends Step {
4344
private final @NonNull DockerServerEndpoint server;
4445

4546
@DataBoundConstructor public ServerEndpointStep(@NonNull DockerServerEndpoint server) {
46-
assert server != null;
47-
this.server = server;
47+
this.server = Objects.requireNonNull(server, "server must not be null");;
4848
}
49-
49+
50+
@NonNull
5051
public DockerServerEndpoint getServer() {
5152
return server;
5253
}
@@ -86,6 +87,7 @@ public static class Execution extends AbstractEndpointStepExecution {
8687
return "withDockerServer";
8788
}
8889

90+
@NonNull
8991
@Override public String getDisplayName() {
9092
return "Sets up Docker server endpoint";
9193
}

src/main/java/org/jenkinsci/plugins/docker/workflow/WithContainerStep.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ public class WithContainerStep extends AbstractStepImpl {
8484
@DataBoundConstructor public WithContainerStep(@NonNull String image) {
8585
this.image = image;
8686
}
87-
87+
88+
@NonNull
8889
public String getImage() {
8990
return image;
9091
}
@@ -247,7 +248,7 @@ private static class Decorator extends LauncherDecorator implements Serializable
247248
private final boolean hasEnv;
248249
private final boolean hasWorkdir;
249250

250-
Decorator(String container, EnvVars envHost, String ws, String toolName, VersionNumber dockerVersion) {
251+
Decorator(String container, EnvVars envHost, String ws, @CheckForNull String toolName, VersionNumber dockerVersion) {
251252
this.container = container;
252253
this.envHost = Util.mapToEnv(envHost);
253254
this.ws = ws;
@@ -256,7 +257,8 @@ private static class Decorator extends LauncherDecorator implements Serializable
256257
this.hasWorkdir = dockerVersion != null && dockerVersion.compareTo(new VersionNumber("17.12")) >= 0;
257258
}
258259

259-
@Override public Launcher decorate(final Launcher launcher, final Node node) {
260+
@NonNull
261+
@Override public Launcher decorate(@NonNull final Launcher launcher, @NonNull final Node node) {
260262
return new Launcher.DecoratedLauncher(launcher) {
261263
@Override public Proc launch(Launcher.ProcStarter starter) throws IOException {
262264
String executable;
@@ -414,6 +416,7 @@ public DescriptorImpl() {
414416
return "withDockerContainer";
415417
}
416418

419+
@NonNull
417420
@Override public String getDisplayName() {
418421
return "Run build steps inside a Docker container";
419422
}

src/main/java/org/jenkinsci/plugins/docker/workflow/client/ControlGroup.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
88
import java.io.InputStreamReader;
99
import java.io.Reader;
1010
import java.nio.charset.StandardCharsets;
11-
import java.util.ArrayList;
12-
import java.util.List;
1311

1412
import java.util.regex.Matcher;
1513
import java.util.regex.Pattern;

src/test/java/org/jenkinsci/plugins/docker/workflow/RegistryEndpointStepTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@
3737
import hudson.model.Node;
3838
import hudson.model.Result;
3939
import hudson.model.User;
40-
import hudson.security.ACL;
41-
import hudson.security.ACLContext;
4240
import jenkins.model.Jenkins;
4341
import jenkins.security.QueueItemAuthenticatorConfiguration;
4442
import org.acegisecurity.Authentication;
@@ -210,7 +208,8 @@ public void stop(@NonNull Throwable throwable) {
210208
}
211209
private static class Decorator extends LauncherDecorator implements Serializable {
212210
private static final long serialVersionUID = 1;
213-
@Override public Launcher decorate(Launcher launcher, Node node) {
211+
@NonNull
212+
@Override public Launcher decorate(@NonNull Launcher launcher, @NonNull Node node) {
214213
return launcher.decorateByPrefix("echo");
215214
}
216215
}
@@ -224,6 +223,7 @@ public Set<? extends Class<?>> getRequiredContext() {
224223
@Override public String getFunctionName() {
225224
return "mockDockerLoginWithEcho";
226225
}
226+
@NonNull
227227
@Override public String getDisplayName() {
228228
return "Mock Docker Login with Echo";
229229
}

0 commit comments

Comments
 (0)