Added custom exceptions (Sonar)

surajkumar · surajkumar · commit d24e18393697 · 2024-05-30T13:27:57.000+01:00
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/exceptions/ComponentInjectionException.java b/annotations/src/main/java/com/javadiscord/jdi/internal/exceptions/ComponentInjectionException.java
@@ -0,0 +1,13 @@
+package com.javadiscord.jdi.internal.exceptions;
+
+public class ComponentInjectionException extends RuntimeException {
+
+    public ComponentInjectionException() {
+        super();
+    }
+
+    public ComponentInjectionException(String message) {
+        super(message);
+    }
+
+}
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/exceptions/NoZeroArgConstructorException.java b/annotations/src/main/java/com/javadiscord/jdi/internal/exceptions/NoZeroArgConstructorException.java
@@ -0,0 +1,13 @@
+package com.javadiscord.jdi.internal.exceptions;
+
+public class NoZeroArgConstructorException extends RuntimeException {
+
+    public NoZeroArgConstructorException() {
+        super();
+    }
+
+    public NoZeroArgConstructorException(String message) {
+        super(message);
+    }
+
+}
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/exceptions/ValidationException.java b/annotations/src/main/java/com/javadiscord/jdi/internal/exceptions/ValidationException.java
@@ -0,0 +1,12 @@
+package com.javadiscord.jdi.internal.exceptions;
+
+public class ValidationException extends RuntimeException {
+
+    public ValidationException() {
+        super();
+    }
+
+    public ValidationException(String message) {
+        super(message);
+    }
+}
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/ClassFileUtil.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/ClassFileUtil.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor;
+package com.javadiscord.jdi.internal.processor;
 
 import java.io.DataInputStream;
 import java.io.File;
@@ -15,7 +15,9 @@ public class ClassFileUtil {
     private static final List<File> classesInPath = new ArrayList<>();
     private static boolean loadedParentJar = false;
 
-    private ClassFileUtil() {}
+    private ClassFileUtil() {
+        throw new UnsupportedOperationException("Utility class");
+    }
 
     public static List<File> getClassesInClassPath() {
         if (classesInPath.isEmpty()) {
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/SlashCommandClassMethod.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/SlashCommandClassMethod.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor;
+package com.javadiscord.jdi.internal.processor;
 
 import java.lang.reflect.Method;
 
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/loader/ComponentLoader.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/loader/ComponentLoader.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor.loader;
+package com.javadiscord.jdi.internal.processor.loader;
 
 import java.io.File;
 import java.lang.reflect.Field;
@@ -10,8 +10,9 @@
 
 import com.javadiscord.jdi.core.annotations.Component;
 import com.javadiscord.jdi.core.annotations.Inject;
-import com.javadiscord.jdi.core.processor.ClassFileUtil;
-import com.javadiscord.jdi.core.processor.validator.ComponentValidator;
+import com.javadiscord.jdi.internal.exceptions.ComponentInjectionException;
+import com.javadiscord.jdi.internal.processor.ClassFileUtil;
+import com.javadiscord.jdi.internal.processor.validator.ComponentValidator;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -102,9 +103,9 @@ private static void injectDependency(Object component, Field field, Object depen
                     field.getType()
                 );
             } catch (IllegalAccessException e) {
-                throw new RuntimeException(
-                    "Failed to inject dependency into field: " + field.getName(),
-                    e
+                throw new ComponentInjectionException(
+                    "Failed to inject dependency into field: " + field.getName() + ", " +
+                        e.getMessage()
                 );
             }
         }
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/loader/ListenerLoader.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/loader/ListenerLoader.java
@@ -1,12 +1,13 @@
-package com.javadiscord.jdi.core.processor.loader;
+package com.javadiscord.jdi.internal.processor.loader;
 
 import java.io.File;
 import java.lang.reflect.Constructor;
 import java.util.List;
 
 import com.javadiscord.jdi.core.annotations.EventListener;
-import com.javadiscord.jdi.core.processor.ClassFileUtil;
-import com.javadiscord.jdi.core.processor.validator.EventListenerValidator;
+import com.javadiscord.jdi.internal.exceptions.NoZeroArgConstructorException;
+import com.javadiscord.jdi.internal.processor.ClassFileUtil;
+import com.javadiscord.jdi.internal.processor.validator.EventListenerValidator;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -65,6 +66,8 @@ public static Constructor<?> getZeroArgConstructor(Class<?> clazz) {
                 return constructor;
             }
         }
-        throw new RuntimeException("No zero arg constructor found for " + clazz.getName());
+        throw new NoZeroArgConstructorException(
+            "No zero arg constructor found for " + clazz.getName()
+        );
     }
 }
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/loader/SlashCommandLoader.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/loader/SlashCommandLoader.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor.loader;
+package com.javadiscord.jdi.internal.processor.loader;
 
 import java.io.File;
 import java.lang.reflect.Constructor;
@@ -7,9 +7,10 @@
 import java.util.Map;
 
 import com.javadiscord.jdi.core.annotations.SlashCommand;
-import com.javadiscord.jdi.core.processor.ClassFileUtil;
-import com.javadiscord.jdi.core.processor.SlashCommandClassMethod;
-import com.javadiscord.jdi.core.processor.validator.SlashCommandValidator;
+import com.javadiscord.jdi.internal.exceptions.ValidationException;
+import com.javadiscord.jdi.internal.processor.ClassFileUtil;
+import com.javadiscord.jdi.internal.processor.SlashCommandClassMethod;
+import com.javadiscord.jdi.internal.processor.validator.SlashCommandValidator;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -38,7 +39,7 @@ private void loadInteractionListeners() {
                                 clazz, method, method.getAnnotation(SlashCommand.class).name()
                             );
                         } else {
-                            throw new RuntimeException(method.getName() + " failed validation");
+                            throw new ValidationException(method.getName() + " failed validation");
                         }
                     }
                 }
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/validator/ComponentValidator.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/validator/ComponentValidator.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor.validator;
+package com.javadiscord.jdi.internal.processor.validator;
 
 import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/validator/EventListenerValidator.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/validator/EventListenerValidator.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor.validator;
+package com.javadiscord.jdi.internal.processor.validator;
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Constructor;
diff --git a/annotations/src/main/java/com/javadiscord/jdi/internal/processor/validator/SlashCommandValidator.java b/annotations/src/main/java/com/javadiscord/jdi/internal/processor/validator/SlashCommandValidator.java
@@ -1,4 +1,4 @@
-package com.javadiscord.jdi.core.processor.validator;
+package com.javadiscord.jdi.internal.processor.validator;
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.Method;
diff --git a/annotations/src/test/unit/com/javadiscord/jdi/core/processor/ClassFileUtilTest.java b/annotations/src/test/unit/com/javadiscord/jdi/core/processor/ClassFileUtilTest.java
@@ -2,6 +2,7 @@
 
 import static org.junit.jupiter.api.Assertions.*;
 
+import com.javadiscord.jdi.internal.processor.ClassFileUtil;
 import org.junit.jupiter.api.Test;
 
 import java.io.File;
diff --git a/annotations/src/test/unit/com/javadiscord/jdi/core/processor/EventListenerValidatorTest.java b/annotations/src/test/unit/com/javadiscord/jdi/core/processor/EventListenerValidatorTest.java
@@ -10,7 +10,7 @@
 import com.javadiscord.jdi.core.models.channel.Channel;
 import com.javadiscord.jdi.core.models.message.Message;
 
-import com.javadiscord.jdi.core.processor.validator.EventListenerValidator;
+import com.javadiscord.jdi.internal.processor.validator.EventListenerValidator;
 import org.junit.jupiter.api.Test;
 
 class EventListenerValidatorTest {
diff --git a/core/src/main/java/com/javadiscord/jdi/core/Constants.java b/core/src/main/java/com/javadiscord/jdi/core/Constants.java
@@ -8,11 +8,11 @@ public class Constants {
         "com.javadiscord.jdi.core.annotations.SlashCommand";
 
     public static final String LISTENER_LOADER_CLASS =
-        "com.javadiscord.jdi.core.processor.loader.ListenerLoader";
+        "com.javadiscord.jdi.internal.processor.loader.ListenerLoader";
     public static final String COMPONENT_LOADER_CLASS =
-        "com.javadiscord.jdi.core.processor.loader.ComponentLoader";
+        "com.javadiscord.jdi.internal.processor.loader.ComponentLoader";
     public static final String SLASH_COMMAND_LOADER_CLASS =
-        "com.javadiscord.jdi.core.processor.loader.SlashCommandLoader";
+        "com.javadiscord.jdi.internal.processor.loader.SlashCommandLoader";
 
     public static final String LAUNCH_HEADER = """
 
diff --git a/core/src/main/java/com/javadiscord/jdi/core/Discord.java b/core/src/main/java/com/javadiscord/jdi/core/Discord.java
@@ -30,6 +30,8 @@
 import com.javadiscord.jdi.internal.api.application_commands.DeleteCommandRequest;
 import com.javadiscord.jdi.internal.cache.Cache;
 import com.javadiscord.jdi.internal.cache.CacheType;
+import com.javadiscord.jdi.internal.exceptions.GatewayException;
+import com.javadiscord.jdi.internal.exceptions.InvalidBotTokenException;
 import com.javadiscord.jdi.internal.gateway.*;
 import com.javadiscord.jdi.internal.gateway.identify.IdentifyRequest;
 
@@ -242,7 +244,7 @@ private void loadComponents() {
             if (componentLoader != null) {
                 componentLoader.loadComponents();
             } else {
-                throw new RuntimeException("Unable to create ComponentLoader instance");
+                throw new InstantiationException("Unable to create ComponentLoader instance");
             }
         } catch (Exception e) {
             LOGGER.warn("Component loading failed", e);
@@ -357,15 +359,15 @@ private static Gateway getGatewayURL(String authentication) {
                 httpClient.send(request, HttpResponse.BodyHandlers.ofString());
 
             if (response.statusCode() == 401) {
-                throw new RuntimeException("Invalid bot token provided");
+                throw new InvalidBotTokenException("Invalid bot token provided");
             }
             if (response.statusCode() != 200) {
-                throw new RuntimeException("Unexpected error occurred: " + response.body());
+                throw new GatewayException("Unexpected error occurred: " + response.body());
             }
             return OBJECT_MAPPER.readValue(response.body(), Gateway.class);
         } catch (Exception e) {
             LOGGER.error("Failed to fetch the gateway URL from discord", e);
-            throw new RuntimeException(e);
+            throw new GatewayException(e.getMessage());
         }
     }
 
diff --git a/core/src/main/java/com/javadiscord/jdi/core/interaction/InteractionEventHandler.java b/core/src/main/java/com/javadiscord/jdi/core/interaction/InteractionEventHandler.java
@@ -12,6 +12,7 @@
 import com.javadiscord.jdi.internal.ReflectiveLoader;
 import com.javadiscord.jdi.internal.ReflectiveSlashCommandClassMethod;
 import com.javadiscord.jdi.internal.ReflectiveSlashCommandLoader;
+import com.javadiscord.jdi.internal.exceptions.InstantiationException;
 
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
@@ -50,7 +51,7 @@ public void onInteractionCreate(Interaction interaction, Guild guild) {
             if (validateParameterCount(method, paramOrder)) {
                 invokeHandler(handler, method, paramOrder);
             } else {
-                throw new RuntimeException(
+                throw new InstantiationException(
                     "Bound " + paramOrder.size() + " parameters but expected "
                         + method.getParameterCount()
                 );
diff --git a/core/src/main/java/com/javadiscord/jdi/internal/exceptions/GatewayException.java b/core/src/main/java/com/javadiscord/jdi/internal/exceptions/GatewayException.java
@@ -0,0 +1,12 @@
+package com.javadiscord.jdi.internal.exceptions;
+
+public class GatewayException extends RuntimeException {
+
+    public GatewayException() {
+        super();
+    }
+
+    public GatewayException(String message) {
+        super(message);
+    }
+}
diff --git a/core/src/main/java/com/javadiscord/jdi/internal/exceptions/InstantiationException.java b/core/src/main/java/com/javadiscord/jdi/internal/exceptions/InstantiationException.java
@@ -0,0 +1,13 @@
+package com.javadiscord.jdi.internal.exceptions;
+
+public class InstantiationException extends RuntimeException {
+
+    public InstantiationException() {
+        super();
+    }
+
+    public InstantiationException(String message) {
+        super(message);
+    }
+
+}
diff --git a/core/src/main/java/com/javadiscord/jdi/internal/exceptions/InvalidBotTokenException.java b/core/src/main/java/com/javadiscord/jdi/internal/exceptions/InvalidBotTokenException.java
@@ -0,0 +1,12 @@
+package com.javadiscord.jdi.internal.exceptions;
+
+public class InvalidBotTokenException extends RuntimeException {
+
+    public InvalidBotTokenException() {
+        super();
+    }
+
+    public InvalidBotTokenException(String message) {
+        super(message);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.javadiscord.jdi.core.processor;`
	`1`	`+package com.javadiscord.jdi.internal.processor;`
`2`	`2`
`3`	`3`	`import java.lang.reflect.Method;`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,13 @@`
`1`		`-package com.javadiscord.jdi.core.processor.loader;`
	`1`	`+package com.javadiscord.jdi.internal.processor.loader;`
`2`	`2`
`3`	`3`	`import java.io.File;`
`4`	`4`	`import java.lang.reflect.Constructor;`
`5`	`5`	`import java.util.List;`
`6`	`6`
`7`	`7`	`import com.javadiscord.jdi.core.annotations.EventListener;`
`8`		`-import com.javadiscord.jdi.core.processor.ClassFileUtil;`
`9`		`-import com.javadiscord.jdi.core.processor.validator.EventListenerValidator;`
	`8`	`+import com.javadiscord.jdi.internal.exceptions.NoZeroArgConstructorException;`
	`9`	`+import com.javadiscord.jdi.internal.processor.ClassFileUtil;`
	`10`	`+import com.javadiscord.jdi.internal.processor.validator.EventListenerValidator;`
`10`	`11`
`11`	`12`	`import org.apache.logging.log4j.LogManager;`
`12`	`13`	`import org.apache.logging.log4j.Logger;`
`@@ -65,6 +66,8 @@ public static Constructor<?> getZeroArgConstructor(Class<?> clazz) {`
`65`	`66`	`return constructor;`
`66`	`67`	`}`
`67`	`68`	`}`
`68`		`- throw new RuntimeException("No zero arg constructor found for " + clazz.getName());`
	`69`	`+ throw new NoZeroArgConstructorException(`
	`70`	`+ "No zero arg constructor found for " + clazz.getName()`
	`71`	`+ );`
`69`	`72`	`}`
`70`	`73`	`}`