Skip to content

Commit 9ea4057

Browse files
committed
Merge pull request #1775 from AlexElin/jaxrs_cleanup
code cleanup in the jaxrs module
2 parents d98de9c + 3dc609d commit 9ea4057

23 files changed

+176
-205
lines changed

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/Reader.java

Lines changed: 54 additions & 69 deletions
Large diffs are not rendered by default.

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/BeanConfig.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
package io.swagger.jaxrs.config;
22

3-
import io.swagger.annotations.Api;
43
import io.swagger.annotations.SwaggerDefinition;
54
import io.swagger.config.FilterFactory;
65
import io.swagger.config.Scanner;
@@ -27,7 +26,7 @@
2726
import java.util.Set;
2827

2928
public class BeanConfig extends AbstractScanner implements Scanner, SwaggerConfig {
30-
Logger LOGGER = LoggerFactory.getLogger(BeanConfig.class);
29+
private static final Logger LOGGER = LoggerFactory.getLogger(BeanConfig.class);
3130

3231
Reader reader = new Reader(new Swagger());
3332

@@ -140,6 +139,7 @@ public void setHost(String host) {
140139
this.host = host;
141140
}
142141

142+
@Override
143143
public String getFilterClass() {
144144
return filterClass;
145145
}
@@ -233,6 +233,7 @@ public void scanAndRead() {
233233
}
234234
}
235235

236+
@Override
236237
public Set<Class<?>> classes() {
237238
ConfigurationBuilder config = new ConfigurationBuilder();
238239
Set<String> acceptablePackages = new HashSet<String>();
@@ -316,6 +317,7 @@ public Swagger getSwagger() {
316317
return reader.getSwagger();
317318
}
318319

320+
@Override
319321
public Swagger configure(Swagger swagger) {
320322
if (schemes != null) {
321323
for (String scheme : schemes) {

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultJaxrsScanner.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
public class DefaultJaxrsScanner extends AbstractScanner implements JaxrsScanner {
99
private boolean prettyPrint = false;
1010

11+
@Override
1112
public Set<Class<?>> classesFromContext(Application app, ServletConfig sc) {
1213
Set<Class<?>> output = new HashSet<Class<?>>();
1314
if (app != null) {
@@ -25,6 +26,7 @@ public Set<Class<?>> classesFromContext(Application app, ServletConfig sc) {
2526
return output;
2627
}
2728

29+
@Override
2830
public Set<Class<?>> classes() {
2931
return new HashSet<Class<?>>();
3032
}
@@ -33,6 +35,7 @@ public boolean prettyPrint() {
3335
return prettyPrint;
3436
}
3537

38+
@Override
3639
public void setPrettyPrint(boolean shouldPrettyPrint) {
3740
this.prettyPrint = shouldPrettyPrint;
3841
}

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/DefaultReaderConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import java.util.HashSet;
66

77
/**
8-
* The <code>ReaderConfig</code> interface defines configuration settings for
8+
* The {@code ReaderConfig} interface defines configuration settings for
99
* JAX-RS annotations reader.
1010
*/
1111
public class DefaultReaderConfig implements ReaderConfig {

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfig.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
import java.util.Collection;
66

77
/**
8-
* The <code>ReaderConfig</code> interface defines configuration settings for
8+
* The {@code ReaderConfig} interface defines configuration settings for
99
* JAX-RS annotations reader.
1010
*/
1111
public interface ReaderConfig {
@@ -14,7 +14,7 @@ public interface ReaderConfig {
1414
* Checks if all resources, but not those with the
1515
* {@link Api} annotation has to be processed.
1616
*
17-
* @return <code>true</code> if all resource has to be processed
17+
* @return {@code true} if all resource has to be processed
1818
*/
1919
boolean isScanAllResources();
2020

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReaderConfigUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import java.util.Set;
99

1010
/**
11-
* The <code>ReaderConfigUtils</code> class defines helper methods for handling
11+
* The {@code ReaderConfigUtils} class defines helper methods for handling
1212
* configuration settings for JAX-RS annotations reader.
1313
*/
1414
public class ReaderConfigUtils {

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/ReflectiveJaxrsScanner.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ public void setResourcePackage(String resourcePackage) {
5959
this.resourcePackage = resourcePackage;
6060
}
6161

62+
@Override
6263
public Swagger configure(Swagger swagger) {
6364
if (filterClass != null) {
6465
try {
@@ -74,6 +75,7 @@ public Swagger configure(Swagger swagger) {
7475
return swagger;
7576
}
7677

78+
@Override
7779
public Set<Class<?>> classes() {
7880
Set<Class<?>> classes = getReflections().getTypesAnnotatedWith(Api.class);
7981
Set<Class<?>> output = new HashSet<Class<?>>();
@@ -85,6 +87,7 @@ public Set<Class<?>> classes() {
8587
return output;
8688
}
8789

90+
@Override
8891
public String getFilterClass() {
8992
return filterClass;
9093
}
@@ -93,10 +96,12 @@ public void setFilterClass(String filterClass) {
9396
this.filterClass = filterClass;
9497
}
9598

99+
@Override
96100
public boolean getPrettyPrint() {
97101
return true;
98102
}
99103

104+
@Override
100105
public void setPrettyPrint(boolean shouldPrettyPrint) {
101106
prettyPrint = shouldPrettyPrint;
102107
}

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/SwaggerContextService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ public static boolean isScannerIdInitParamDefined(ServletConfig sc) {
256256
if (key != null){
257257
return true;
258258
} else {
259-
return (sc.getInitParameter(CONTEXT_ID_KEY) != null) ? true : false;
259+
return (sc.getInitParameter(CONTEXT_ID_KEY) != null);
260260
}
261261
}
262262

@@ -276,7 +276,7 @@ public static boolean isConfigIdInitParamDefined(ServletConfig sc) {
276276
if (key != null){
277277
return true;
278278
} else {
279-
return (sc.getInitParameter(CONTEXT_ID_KEY) != null) ? true : false;
279+
return (sc.getInitParameter(CONTEXT_ID_KEY) != null);
280280
}
281281
}
282282

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/config/WebXMLReader.java

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,14 @@
1414
import java.util.List;
1515

1616
public class WebXMLReader implements SwaggerConfig {
17-
protected String basePath,
18-
host,
19-
filterClass,
20-
apiVersion,
21-
title;
17+
private static final Logger LOGGER = LoggerFactory.getLogger(WebXMLReader.class);
18+
19+
protected String basePath;
20+
protected String host;
21+
protected String filterClass;
22+
protected String apiVersion;
23+
protected String title;
2224
protected String[] schemes = new String[]{};
23-
private Logger LOGGER = LoggerFactory.getLogger(WebXMLReader.class);
2425

2526
public WebXMLReader(ServletConfig servletConfig) {
2627
apiVersion = servletConfig.getInitParameter("api.version");
@@ -83,10 +84,12 @@ public WebXMLReader(ServletConfig servletConfig) {
8384
}
8485
}
8586

87+
@Override
8688
public String getFilterClass() {
8789
return filterClass;
8890
}
8991

92+
@Override
9093
public Swagger configure(Swagger swagger) {
9194
if (swagger != null) {
9295
Info info = swagger.getInfo();

modules/swagger-jaxrs/src/main/java/io/swagger/jaxrs/ext/SwaggerExtensions.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import java.util.ServiceLoader;
1111

1212
public class SwaggerExtensions {
13-
static Logger LOGGER = LoggerFactory.getLogger(SwaggerExtensions.class);
13+
private static Logger LOGGER = LoggerFactory.getLogger(SwaggerExtensions.class);
1414

1515
private static List<SwaggerExtension> extensions = null;
1616

@@ -29,9 +29,7 @@ public static Iterator<SwaggerExtension> chain() {
2929
static {
3030
extensions = new ArrayList<SwaggerExtension>();
3131
ServiceLoader<SwaggerExtension> loader = ServiceLoader.load(SwaggerExtension.class);
32-
Iterator<SwaggerExtension> itr = loader.iterator();
33-
while (itr.hasNext()) {
34-
SwaggerExtension ext = itr.next();
32+
for (SwaggerExtension ext : loader) {
3533
LOGGER.debug("adding extension " + ext);
3634
extensions.add(ext);
3735
}

0 commit comments

Comments
 (0)