Skip to content

Commit 16c45d5

Browse files
jasonlessenichjasonlessenich
committed
fix checkstyle
1 parent ad98cf3 commit 16c45d5

16 files changed

Lines changed: 91 additions & 31 deletions

‎build.gradle.kts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,6 @@ dependencies {
6565

6666
// Spring Boot
6767
implementation("org.springframework.boot:spring-boot-starter-web:2.7.0")
68-
69-
// Apache HTTP-Client
70-
implementation("org.apache.httpcomponents:httpclient:4.5.13")
7168
}
7269

7370
tasks.withType<Jar> {

‎checkstyle/suppressions.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<suppressions>
2+
<suppress files="SpringBootApplication.java" checks="HideUtilityClassConstructor" />
3+
</suppressions>

‎src/main/java/net/javadiscord/javabot/Bot.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,6 @@ public class Bot {
9494
@Getter
9595
private static ScheduledExecutorService asyncPool;
9696

97-
public Bot() {}
98-
9997
/**
10098
* The main method that starts the bot. This involves a few steps:
10199
* <ol>
@@ -109,6 +107,7 @@ public Bot() {}
109107
* @param args Command-line arguments.
110108
* @throws Exception If any exception occurs during bot creation.
111109
*/
110+
@SuppressWarnings("checkstyle:hideutilityclassconstructor")
112111
public static void main(String[] args) throws Exception {
113112
TimeZone.setDefault(TimeZone.getTimeZone(ZoneOffset.UTC));
114113
config = new BotConfig(Path.of("config"));

‎src/main/java/net/javadiscord/javabot/api/gson/GsonColorAdapter.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55

66
import java.awt.*;
77
import java.lang.reflect.Type;
8-
import java.time.LocalDateTime;
9-
import java.time.format.DateTimeFormatter;
108

9+
/**
10+
* Adapter class for {@link Gson} which configures the serialization and deserialization of the {@link Color} class.
11+
*/
1112
public class GsonColorAdapter implements JsonSerializer<Color>, JsonDeserializer<Color> {
1213

1314
@Override

‎src/main/java/net/javadiscord/javabot/api/gson/GsonLocalDateTimeAdapter.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
import java.time.LocalDateTime;
77
import java.time.format.DateTimeFormatter;
88

9+
/**
10+
* Adapter class for {@link Gson} which configures the serialization and deserialization of the {@link LocalDateTime} class.
11+
*/
912
public class GsonLocalDateTimeAdapter implements JsonSerializer<LocalDateTime>, JsonDeserializer<LocalDateTime> {
1013

1114
@Override

‎src/main/java/net/javadiscord/javabot/api/response/ApiResponseBuilder.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,18 @@
1010
import java.util.HashMap;
1111
import java.util.Map;
1212

13+
/**
14+
* Utility class used to build JSON responses.
15+
*/
1316
public class ApiResponseBuilder {
1417

1518
private final Gson gson;
1619
private final Map<String, Object> params;
1720

21+
/**
22+
* The constructor of this class which creates a new {@link Gson}
23+
* and initializes the {@link ApiResponseBuilder#params}.
24+
*/
1825
public ApiResponseBuilder() {
1926
gson = new GsonBuilder()
2027
.setPrettyPrinting()

‎src/main/java/net/javadiscord/javabot/api/response/ApiResponses.java‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,30 @@
11
package net.javadiscord.javabot.api.response;
22

3+
/**
4+
* Utility class which contains some basic JSON responses.
5+
*/
36
public class ApiResponses {
4-
public static String INTERNAL_SERVER_ERROR = buildError("internal_server_error", "Internal server error encountered");
5-
public static String NOT_FOUND_ERROR = buildError("not_found", "Resource not found");
6-
public static String BAD_REQUEST = buildError("bad_request", "Bad Request");
7-
public static String REQUEST_METHOD_NOT_SUPPORTED = buildError("unsupported_method", "Request method not supported");
8-
public static String INVALID_GUILD_IN_REQUEST = buildError("invalid_guild", "Invalid 'guild_id' in request");
9-
public static String INVALID_USER_IN_REQUEST = buildError("invalid_user", "Invalid 'user_id' in request");
10-
public static String INVALID_NUMBER_IN_REQUEST = buildError("invalid_number", "Invalid number in request");
7+
/**
8+
* Response used for internal server errors (such as exceptions).
9+
*/
10+
public static final String INTERNAL_SERVER_ERROR = buildError("internal_server_error", "Internal server error encountered");
11+
/**
12+
* Response used for invalid {@link net.dv8tion.jda.api.entities.Guild} ids.
13+
*/
14+
public static final String INVALID_GUILD_IN_REQUEST = buildError("invalid_guild", "Invalid 'guild_id' in request");
15+
/**
16+
* Response used for invalid {@link net.dv8tion.jda.api.entities.User} ids.
17+
*/
18+
public static final String INVALID_USER_IN_REQUEST = buildError("invalid_user", "Invalid 'user_id' in request");
19+
/**
20+
* Response used for invalid integers in the request.
21+
*/
22+
public static final String INVALID_NUMBER_IN_REQUEST = buildError("invalid_number", "Invalid number in request");
1123

12-
private static String buildError(String name, String description) {
13-
return new ApiResponseBuilder().add("error", name).add("error_description", description).build();
14-
}
24+
private ApiResponses() {
25+
}
26+
27+
private static String buildError(String name, String description) {
28+
return new ApiResponseBuilder().add("error", name).add("error_description", description).build();
29+
}
1530
}

‎src/main/java/net/javadiscord/javabot/api/routes/JDAEntity.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
import net.dv8tion.jda.api.JDA;
44
import net.javadiscord.javabot.Bot;
55

6+
/**
7+
* Simple interface which adds the {@link JDAEntity#getJDA()} method which
8+
* returns the bots' {@link JDA} client.
9+
*/
610
public interface JDAEntity {
711
default JDA getJDA() {
812
return Bot.getDih4jda().getJDA();

‎src/main/java/net/javadiscord/javabot/api/routes/metrics/model/MetricsData.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
import lombok.Data;
44

5+
/**
6+
* API-Data class which contains all necessary information about a guilds'
7+
* metrics.
8+
*/
59
@Data
610
public class MetricsData {
711
private long memberCount;

‎src/main/java/net/javadiscord/javabot/api/routes/qotw_leaderboard/QOTWLeaderboardController.java‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import net.dv8tion.jda.api.entities.Guild;
44
import net.javadiscord.javabot.Bot;
5-
import net.javadiscord.javabot.api.routes.qotw_leaderboard.model.QOTWLeaderboardData;
65
import net.javadiscord.javabot.api.response.ApiResponseBuilder;
76
import net.javadiscord.javabot.api.response.ApiResponses;
87
import net.javadiscord.javabot.api.routes.JDAEntity;
@@ -19,9 +18,20 @@
1918

2019
import java.util.List;
2120

21+
/**
22+
* Handles all GET-Requests on the {guild_id}/qotw/leaderboard route.
23+
*/
2224
@RestController
2325
public class QOTWLeaderboardController implements JDAEntity {
2426

27+
/**
28+
* Serves the specified amount of users. Sorted by the
29+
* amount of qotw-points.
30+
*
31+
* @param guildId The guilds' id.
32+
* @param amountParam The amount of users to return. Defaults to 3.
33+
* @return The {@link ResponseEntity}.
34+
*/
2535
@GetMapping(
2636
value = "{guild_id}/qotw/leaderboard",
2737
produces = MediaType.APPLICATION_JSON_VALUE
@@ -50,8 +60,6 @@ public ResponseEntity<String> getQOTWLeaderboard(
5060
return data;
5161
})
5262
.toList();
53-
QOTWLeaderboardData data = new QOTWLeaderboardData();
54-
data.setAccounts(members);
5563
return new ResponseEntity<>(new ApiResponseBuilder().add("leaderboard", members).build(), HttpStatus.OK);
5664
}
5765
}

0 commit comments

Comments
 (0)