fix checkstyle

Author: jasonlessenich

build.gradle.kts

@@ -65,9 +65,6 @@ dependencies {
 
     // Spring Boot
     implementation("org.springframework.boot:spring-boot-starter-web:2.7.0")
-
-    // Apache HTTP-Client
-    implementation("org.apache.httpcomponents:httpclient:4.5.13")
 }
 
 tasks.withType<Jar> {

checkstyle/suppressions.xml

@@ -0,0 +1,3 @@
+<suppressions>
+    <suppress files="SpringBootApplication.java" checks="HideUtilityClassConstructor" />
+</suppressions>

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

@@ -94,8 +94,6 @@ public class Bot {
 	@Getter
 	private static ScheduledExecutorService asyncPool;
 
-	public Bot() {}
-
 	/**
 	 * The main method that starts the bot. This involves a few steps:
 	 * <ol>
@@ -109,6 +107,7 @@ public Bot() {}
 	 * @param args Command-line arguments.
 	 * @throws Exception If any exception occurs during bot creation.
 	 */
+	@SuppressWarnings("checkstyle:hideutilityclassconstructor")
 	public static void main(String[] args) throws Exception {
 		TimeZone.setDefault(TimeZone.getTimeZone(ZoneOffset.UTC));
 		config = new BotConfig(Path.of("config"));

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

@@ -5,9 +5,10 @@
 
 import java.awt.*;
 import java.lang.reflect.Type;
-import java.time.LocalDateTime;
-import java.time.format.DateTimeFormatter;
 
+/**
+ * Adapter class for {@link Gson} which configures the serialization and deserialization of the {@link Color} class.
+ */
 public class GsonColorAdapter implements JsonSerializer<Color>, JsonDeserializer<Color> {
 
 	@Override

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

@@ -6,6 +6,9 @@
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
 
+/**
+ * Adapter class for {@link Gson} which configures the serialization and deserialization of the {@link LocalDateTime} class.
+ */
 public class GsonLocalDateTimeAdapter implements JsonSerializer<LocalDateTime>, JsonDeserializer<LocalDateTime> {
 
 	@Override

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

@@ -10,11 +10,18 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Utility class used to build JSON responses.
+ */
 public class ApiResponseBuilder {
 
 	private final Gson gson;
 	private final Map<String, Object> params;
 
+	/**
+	 * The constructor of this class which creates a new {@link Gson}
+	 * and initializes the {@link ApiResponseBuilder#params}.
+	 */
 	public ApiResponseBuilder() {
 		gson = new GsonBuilder()
 				.setPrettyPrinting()

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

@@ -1,15 +1,30 @@
 package net.javadiscord.javabot.api.response;
 
+/**
+ * Utility class which contains some basic JSON responses.
+ */
 public class ApiResponses {
-		public static String INTERNAL_SERVER_ERROR = buildError("internal_server_error", "Internal server error encountered");
-		public static String NOT_FOUND_ERROR = buildError("not_found", "Resource not found");
-		public static String BAD_REQUEST = buildError("bad_request", "Bad Request");
-		public static String REQUEST_METHOD_NOT_SUPPORTED = buildError("unsupported_method", "Request method not supported");
-		public static String INVALID_GUILD_IN_REQUEST = buildError("invalid_guild", "Invalid 'guild_id' in request");
-		public static String INVALID_USER_IN_REQUEST = buildError("invalid_user", "Invalid 'user_id' in request");
-		public static String INVALID_NUMBER_IN_REQUEST = buildError("invalid_number", "Invalid number in request");
+	/**
+	 * Response used for internal server errors (such as exceptions).
+	 */
+	public static final String INTERNAL_SERVER_ERROR = buildError("internal_server_error", "Internal server error encountered");
+	/**
+	 * Response used for invalid {@link net.dv8tion.jda.api.entities.Guild} ids.
+	 */
+	public static final String INVALID_GUILD_IN_REQUEST = buildError("invalid_guild", "Invalid 'guild_id' in request");
+	/**
+	 * Response used for invalid {@link net.dv8tion.jda.api.entities.User} ids.
+	 */
+	public static final String INVALID_USER_IN_REQUEST = buildError("invalid_user", "Invalid 'user_id' in request");
+	/**
+	 * Response used for invalid integers in the request.
+	 */
+	public static final String INVALID_NUMBER_IN_REQUEST = buildError("invalid_number", "Invalid number in request");
 
-		private static String buildError(String name, String description) {
-			return new ApiResponseBuilder().add("error", name).add("error_description", description).build();
-		}
+	private ApiResponses() {
+	}
+
+	private static String buildError(String name, String description) {
+		return new ApiResponseBuilder().add("error", name).add("error_description", description).build();
+	}
 }

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

@@ -3,6 +3,10 @@
 import net.dv8tion.jda.api.JDA;
 import net.javadiscord.javabot.Bot;
 
+/**
+ * Simple interface which adds the {@link JDAEntity#getJDA()} method which
+ * returns the bots' {@link JDA} client.
+ */
 public interface JDAEntity {
 	default JDA getJDA() {
 		return Bot.getDih4jda().getJDA();

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

@@ -2,6 +2,10 @@
 
 import lombok.Data;
 
+/**
+ * API-Data class which contains all necessary information about a guilds'
+ * metrics.
+ */
 @Data
 public class MetricsData {
 	private long memberCount;

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

@@ -2,7 +2,6 @@
 
 import net.dv8tion.jda.api.entities.Guild;
 import net.javadiscord.javabot.Bot;
-import net.javadiscord.javabot.api.routes.qotw_leaderboard.model.QOTWLeaderboardData;
 import net.javadiscord.javabot.api.response.ApiResponseBuilder;
 import net.javadiscord.javabot.api.response.ApiResponses;
 import net.javadiscord.javabot.api.routes.JDAEntity;
@@ -19,9 +18,20 @@
 
 import java.util.List;
 
+/**
+ * Handles all GET-Requests on the {guild_id}/qotw/leaderboard route.
+ */
 @RestController
 public class QOTWLeaderboardController implements JDAEntity {
 
+	/**
+	 * Serves the specified amount of users. Sorted by the
+	 * amount of qotw-points.
+	 *
+	 * @param guildId     The guilds' id.
+	 * @param amountParam The amount of users to return. Defaults to 3.
+	 * @return The {@link ResponseEntity}.
+	 */
 	@GetMapping(
 			value = "{guild_id}/qotw/leaderboard",
 			produces = MediaType.APPLICATION_JSON_VALUE
@@ -50,8 +60,6 @@ public ResponseEntity<String> getQOTWLeaderboard(
 					return data;
 				})
 				.toList();
-		QOTWLeaderboardData data = new QOTWLeaderboardData();
-		data.setAccounts(members);
 		return new ResponseEntity<>(new ApiResponseBuilder().add("leaderboard", members).build(), HttpStatus.OK);
 	}
 }