Skip to content

Commit 4f452dc

Browse files
zbynekslide
zbynek
authored and
slide
committed
Apply spotless code style
1 parent ba3d36b commit 4f452dc

File tree

64 files changed

+1882
-1535
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+1882
-1535
lines changed

‎pom.xml‎

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
12
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
23
<modelVersion>4.0.0</modelVersion>
34

@@ -8,14 +9,13 @@
89
<relativePath />
910
</parent>
1011

11-
<properties>
12-
<changelist>999999-SNAPSHOT</changelist>
13-
<gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
14-
<!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
15-
<jenkins.baseline>2.479</jenkins.baseline>
16-
<jenkins.version>${jenkins.baseline}.1</jenkins.version>
17-
</properties>
18-
12+
<artifactId>token-macro</artifactId>
13+
<version>${changelist}</version>
14+
<packaging>hpi</packaging>
15+
<name>Token Macro Plugin</name>
16+
<description>This plugin adds reusable macro expansion capability for other plugins to use.</description>
17+
<url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
18+
1919
<licenses>
2020
<license>
2121
<name>The MIT License (MIT)</name>
@@ -24,13 +24,6 @@
2424
</license>
2525
</licenses>
2626

27-
<artifactId>token-macro</artifactId>
28-
<version>${changelist}</version>
29-
<packaging>hpi</packaging>
30-
<name>Token Macro Plugin</name>
31-
<description>This plugin adds reusable macro expansion capability for other plugins to use.</description>
32-
<url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
33-
3427
<developers>
3528
<developer>
3629
<id>kohsuke</id>
@@ -47,18 +40,26 @@
4740
<scm>
4841
<connection>scm:git:https://github.com/${gitHubRepo}.git</connection>
4942
<developerConnection>scm:git:git@github.com:${gitHubRepo}.git</developerConnection>
50-
<url>https://github.com/${gitHubRepo}</url>
5143
<tag>${scmTag}</tag>
44+
<url>https://github.com/${gitHubRepo}</url>
5245
</scm>
5346

47+
<properties>
48+
<changelist>999999-SNAPSHOT</changelist>
49+
<gitHubRepo>jenkinsci/${project.artifactId}-plugin</gitHubRepo>
50+
<!-- https://www.jenkins.io/doc/developer/plugin-development/choosing-jenkins-baseline/ -->
51+
<jenkins.baseline>2.479</jenkins.baseline>
52+
<jenkins.version>${jenkins.baseline}.1</jenkins.version>
53+
</properties>
54+
5455
<dependencyManagement>
5556
<dependencies>
5657
<dependency>
5758
<groupId>io.jenkins.tools.bom</groupId>
5859
<artifactId>bom-${jenkins.baseline}.x</artifactId>
5960
<version>4023.va_eeb_b_4e45f07</version>
60-
<scope>import</scope>
6161
<type>pom</type>
62+
<scope>import</scope>
6263
</dependency>
6364
</dependencies>
6465
</dependencyManagement>
@@ -74,12 +75,12 @@
7475
</dependency>
7576
<dependency>
7677
<groupId>org.jenkins-ci.plugins.workflow</groupId>
77-
<artifactId>workflow-job</artifactId>
78+
<artifactId>workflow-api</artifactId>
7879
<optional>true</optional>
7980
</dependency>
8081
<dependency>
8182
<groupId>org.jenkins-ci.plugins.workflow</groupId>
82-
<artifactId>workflow-api</artifactId>
83+
<artifactId>workflow-job</artifactId>
8384
<optional>true</optional>
8485
</dependency>
8586
<dependency>
@@ -100,17 +101,17 @@
100101
</dependency>
101102
<dependency>
102103
<groupId>org.jenkins-ci.plugins.workflow</groupId>
103-
<artifactId>workflow-cps</artifactId>
104+
<artifactId>workflow-basic-steps</artifactId>
104105
<scope>test</scope>
105106
</dependency>
106107
<dependency>
107108
<groupId>org.jenkins-ci.plugins.workflow</groupId>
108-
<artifactId>workflow-durable-task-step</artifactId>
109+
<artifactId>workflow-cps</artifactId>
109110
<scope>test</scope>
110111
</dependency>
111112
<dependency>
112113
<groupId>org.jenkins-ci.plugins.workflow</groupId>
113-
<artifactId>workflow-basic-steps</artifactId>
114+
<artifactId>workflow-durable-task-step</artifactId>
114115
<scope>test</scope>
115116
</dependency>
116117
<dependency>

‎src/main/java/org/jenkinsci/plugins/tokenmacro/DataBoundTokenMacro.java‎

Lines changed: 51 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,14 @@
2323
*/
2424
package org.jenkinsci.plugins.tokenmacro;
2525

26+
import static java.lang.annotation.ElementType.*;
27+
import static java.lang.annotation.RetentionPolicy.*;
28+
2629
import com.google.common.collect.ListMultimap;
2730
import hudson.FilePath;
2831
import hudson.model.AbstractBuild;
2932
import hudson.model.Run;
3033
import hudson.model.TaskListener;
31-
import org.apache.commons.beanutils.ConvertUtils;
32-
3334
import java.beans.Introspector;
3435
import java.io.IOException;
3536
import java.lang.annotation.Retention;
@@ -41,10 +42,7 @@
4142
import java.util.Map;
4243
import java.util.Map.Entry;
4344
import java.util.concurrent.ConcurrentHashMap;
44-
45-
import static java.lang.annotation.ElementType.*;
46-
import static java.lang.annotation.RetentionPolicy.*;
47-
45+
import org.apache.commons.beanutils.ConvertUtils;
4846
import org.apache.commons.lang.StringEscapeUtils;
4947
import org.apache.commons.lang.StringUtils;
5048

@@ -64,11 +62,11 @@
6462
public abstract class DataBoundTokenMacro extends TokenMacro {
6563

6664
@Retention(RUNTIME)
67-
@Target({FIELD,METHOD})
65+
@Target({FIELD, METHOD})
6866
public @interface Parameter {
6967
boolean required() default false;
7068

71-
String alias() default "";
69+
String alias() default "";
7270
}
7371

7472
private interface Setter {
@@ -85,7 +83,8 @@ private interface Setter {
8583
boolean required();
8684
}
8785

88-
private Map<String,Setter> setters;
86+
private Map<String, Setter> setters;
87+
8988
@Parameter
9089
public boolean escapeHtml = false;
9190

@@ -97,27 +96,27 @@ public DataBoundTokenMacro() {
9796
* Builds up the {@link #setters} map that encapsulates where/how to set the value.
9897
*/
9998
private void buildMap() {
100-
if (setters!=null) return;
99+
if (setters != null) return;
101100

102101
setters = new ConcurrentHashMap<>();
103102
for (final Field f : getClass().getFields()) {
104103
final Parameter p = f.getAnnotation(Parameter.class);
105-
if (p !=null) {
104+
if (p != null) {
106105
String name = f.getName();
107106
if (StringUtils.isNotEmpty(p.alias())) {
108107
name = p.alias();
109108
}
110109

111-
setters.put(name,new Setter() {
110+
setters.put(name, new Setter() {
112111
public Class<?> getType() {
113112
return f.getType();
114113
}
115114

116115
public void set(Object target, Object value) {
117116
try {
118-
f.set(target,value);
117+
f.set(target, value);
119118
} catch (IllegalAccessException e) {
120-
throw (IllegalAccessError)new IllegalAccessError(e.getMessage()).initCause(e);
119+
throw (IllegalAccessError) new IllegalAccessError(e.getMessage()).initCause(e);
121120
}
122121
}
123122

@@ -130,10 +129,11 @@ public boolean required() {
130129

131130
for (final Method m : getClass().getMethods()) {
132131
final Parameter p = m.getAnnotation(Parameter.class);
133-
if (p !=null) {
132+
if (p != null) {
134133
final Class<?>[] pt = m.getParameterTypes();
135-
if (pt.length!=1)
136-
throw new IllegalArgumentException("Expecting one-arg method for @Parameter but found "+m+" instead");
134+
if (pt.length != 1)
135+
throw new IllegalArgumentException(
136+
"Expecting one-arg method for @Parameter but found " + m + " instead");
137137

138138
String name = m.getName();
139139
if (name.startsWith("set")) {
@@ -144,16 +144,16 @@ public boolean required() {
144144
name = p.alias();
145145
}
146146

147-
setters.put(name,new Setter() {
147+
setters.put(name, new Setter() {
148148
public Class<?> getType() {
149149
return pt[0];
150150
}
151151

152152
public void set(Object target, Object value) {
153153
try {
154-
m.invoke(target,value);
154+
m.invoke(target, value);
155155
} catch (IllegalAccessException e) {
156-
throw (IllegalAccessError)new IllegalAccessError(e.getMessage()).initCause(e);
156+
throw (IllegalAccessError) new IllegalAccessError(e.getMessage()).initCause(e);
157157
} catch (InvocationTargetException e) {
158158
throw new Error(e);
159159
}
@@ -167,28 +167,30 @@ public boolean required() {
167167
}
168168
}
169169

170-
private DataBoundTokenMacro prepare(String macroName, Map<String, String> arguments, ListMultimap<String, String> argumentMultimap) throws MacroEvaluationException {
170+
private DataBoundTokenMacro prepare(
171+
String macroName, Map<String, String> arguments, ListMultimap<String, String> argumentMultimap)
172+
throws MacroEvaluationException {
171173
DataBoundTokenMacro copy;
172174
try {
173175
copy = getClass().newInstance();
174176

175177
for (Entry<String, String> e : argumentMultimap.entries()) {
176178
Setter s = setters.get(e.getKey());
177-
if (s==null)
178-
throw new MacroEvaluationException(MessageFormat.format("Undefined parameter {0} in token {1}", e.getKey(),macroName));
179+
if (s == null)
180+
throw new MacroEvaluationException(
181+
MessageFormat.format("Undefined parameter {0} in token {1}", e.getKey(), macroName));
179182

180183
Object v;
181-
if (s.getType()==boolean.class && e.getValue()==null)
182-
v = true;
183-
else
184-
v = ConvertUtils.convert(e.getValue(), s.getType());
184+
if (s.getType() == boolean.class && e.getValue() == null) v = true;
185+
else v = ConvertUtils.convert(e.getValue(), s.getType());
185186

186187
s.set(copy, v);
187188
}
188189

189190
for (Entry<String, Setter> e : setters.entrySet()) {
190191
if (!arguments.containsKey(e.getKey()) && e.getValue().required())
191-
throw new MacroEvaluationException(MessageFormat.format("Parameter {0} in token {1} is required but was not specfified", e.getKey(), macroName));
192+
throw new MacroEvaluationException(MessageFormat.format(
193+
"Parameter {0} in token {1} is required but was not specfified", e.getKey(), macroName));
192194
}
193195
} catch (InstantiationException e) {
194196
throw new Error(e);
@@ -200,8 +202,14 @@ private DataBoundTokenMacro prepare(String macroName, Map<String, String> argume
200202
}
201203

202204
@Override
203-
public String evaluate(AbstractBuild<?, ?> build, TaskListener listener, String macroName, Map<String, String> arguments, ListMultimap<String, String> argumentMultimap) throws MacroEvaluationException, IOException, InterruptedException {
204-
DataBoundTokenMacro copy = prepare(macroName,arguments,argumentMultimap);
205+
public String evaluate(
206+
AbstractBuild<?, ?> build,
207+
TaskListener listener,
208+
String macroName,
209+
Map<String, String> arguments,
210+
ListMultimap<String, String> argumentMultimap)
211+
throws MacroEvaluationException, IOException, InterruptedException {
212+
DataBoundTokenMacro copy = prepare(macroName, arguments, argumentMultimap);
205213
String res = copy.evaluate(build, listener, macroName);
206214
if (copy.escapeHtml && !copy.handlesHtmlEscapeInternally()) {
207215
res = StringEscapeUtils.escapeHtml(res);
@@ -210,8 +218,15 @@ public String evaluate(AbstractBuild<?, ?> build, TaskListener listener, String
210218
}
211219

212220
@Override
213-
public String evaluate(Run<?,?> run, FilePath workspace, TaskListener listener, String macroName, Map<String, String> arguments, ListMultimap<String, String> argumentMultimap) throws MacroEvaluationException, IOException, InterruptedException {
214-
DataBoundTokenMacro copy = prepare(macroName,arguments,argumentMultimap);
221+
public String evaluate(
222+
Run<?, ?> run,
223+
FilePath workspace,
224+
TaskListener listener,
225+
String macroName,
226+
Map<String, String> arguments,
227+
ListMultimap<String, String> argumentMultimap)
228+
throws MacroEvaluationException, IOException, InterruptedException {
229+
DataBoundTokenMacro copy = prepare(macroName, arguments, argumentMultimap);
215230
String res = copy.evaluate(run, workspace, listener, macroName);
216231
if (copy.escapeHtml && !copy.handlesHtmlEscapeInternally()) {
217232
res = StringEscapeUtils.escapeHtml(res);
@@ -234,9 +249,11 @@ public boolean handlesHtmlEscapeInternally() {
234249
return false;
235250
}
236251

237-
public abstract String evaluate(AbstractBuild<?, ?> context, TaskListener listener, String macroName) throws MacroEvaluationException, IOException, InterruptedException;
252+
public abstract String evaluate(AbstractBuild<?, ?> context, TaskListener listener, String macroName)
253+
throws MacroEvaluationException, IOException, InterruptedException;
238254

239-
public String evaluate(Run<?,?> run, FilePath workspace, TaskListener listener, String macroName) throws MacroEvaluationException, IOException, InterruptedException {
255+
public String evaluate(Run<?, ?> run, FilePath workspace, TaskListener listener, String macroName)
256+
throws MacroEvaluationException, IOException, InterruptedException {
240257
return macroName + " is not supported in this context";
241258
}
242259

‎src/main/java/org/jenkinsci/plugins/tokenmacro/MacroEvaluationException.java‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,23 @@
3333
* @author Kohsuke Kawaguchi
3434
*/
3535
public class MacroEvaluationException extends Exception {
36-
36+
3737
private final @CheckForNull String macroName;
38-
38+
3939
public MacroEvaluationException(@NonNull String message) {
4040
this(message, null, null);
4141
}
42-
42+
4343
public MacroEvaluationException(@NonNull String message, @CheckForNull Throwable cause) {
4444
this(message, null, cause);
4545
}
4646

4747
public MacroEvaluationException(@CheckForNull String message, @NonNull String macroName) {
4848
this(message, macroName, null);
4949
}
50-
51-
public MacroEvaluationException(@CheckForNull String message, @CheckForNull String macroName, @CheckForNull Throwable cause) {
50+
51+
public MacroEvaluationException(
52+
@CheckForNull String message, @CheckForNull String macroName, @CheckForNull Throwable cause) {
5253
super(message, cause);
5354
this.macroName = macroName;
5455
}

0 commit comments

Comments
 (0)