V1.2.0: Constructor Dependency Retriever Added

Author: Dev-Bjorn

README.md

@@ -17,7 +17,7 @@ Add this to your `pom.xml`.
 <dependency>
     <groupId>nl.devoxist</groupId>
     <artifactId>module-scheduler</artifactId>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
 </dependency>
 ```
 
@@ -61,8 +61,12 @@ public class ModuleA implements Module {
 }
 ```
 
-To mark a dependency link to another module use the `@Dependency` annotation above the class of the `Module`. This
-annotation is needed to order the Modules.
+To mark a dependency to another module use the `@Dependency` annotation above the class of the `Module`. And/Or the
+dependencies can be added in a constructor. If the dependency is added in any constructor, then the annotation is not
+required and vice versa. The dependencies in the constructor and the value of the annotation need to be extended by
+the `Module` class. Only the constructor parameters that are extended by the `Module` class will be injected by the
+system, others parameters that are not extended need to be delivered by through the registers, 
+`ModuleSchedulerSettings#addRegisters`. These dependencies manipulate the order in which the modules are getting runned.
 
 ```java
 
@@ -81,15 +85,19 @@ public class ModuleB implements Module {
 }
 ```
 
-To mark a multiple dependency links to another module use the `@Dependency` annotation above the class of the `Module`.
-This annotation is needed to order the Modules.
+If a module has multiple dependencies, add the dependencies in the `@Dependency` annotation like an array. And/Or add
+the dependencies in a constructor. These dependencies can be added in multiple constructors. Like in the example below.
 
 ```java
 
 @Dependency({ModuleB.class, ModuleA.class})
 public class ModuleC implements Module {
 
-    public ModuleC(ModuleA moduleA, ModuleB moduleB) {
+    public ModuleC(ModuleA moduleA) {
+        // Put here your stuff
+    }
+
+    public ModuleC(ModuleB moduleB) {
         // Put here your stuff
     }
 

pom.xml

@@ -29,7 +29,7 @@
     <groupId>nl.devoxist</groupId>
     <artifactId>module-scheduler</artifactId>
     <packaging>jar</packaging>
-    <version>1.1.0</version>
+    <version>1.2.0</version>
 
     <name>Module Scheduler</name>
     <description>An API to order tasks in the correct order</description>

src/main/java/nl/devoxist/modulescheduler/collection/Arrays.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2023 Devoxist, Dev-Bjorn
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package nl.devoxist.modulescheduler.collection;
+
+import nl.devoxist.modulescheduler.resolvers.DependencyRetriever;
+import org.jetbrains.annotations.NotNull;
+
+import java.lang.reflect.Array;
+
+/**
+ * {@link Arrays} is an object that has functions that manipulate an {@link Array}.
+ *
+ * @author Dev-Bjorn
+ * @version 1.2.0
+ * @since 1.2.0
+ */
+public class Arrays {
+
+    /**
+     * Construct a new {@link DependencyRetriever} object. This always fails, because the class is a static class.
+     * So it only contains static objects. Thus, it throws an {@link IllegalAccessException}.
+     *
+     * @throws IllegalAccessException If the {@link DependencyRetriever} was try to construct the class. The
+     *                                construction of this class is not possible, because this is a static class.
+     * @since 1.2.0
+     */
+    private Arrays() throws IllegalAccessException {
+        throw new IllegalAccessException("This class is a static class, so the construction is not accessible.");
+    }
+
+    /**
+     * Merge two arrays into one array.
+     *
+     * @param firstArray  The first array that going to be merged with the second array.
+     * @param secondArray The second array that will be merged into the first array.
+     * @param <T>         The type of the arrays.
+     *
+     * @return The merged array.
+     *
+     * @since 1.2.0
+     */
+    public static <T> T @NotNull [] concatArrays(T[] firstArray, T @NotNull [] secondArray) {
+        T[] result = java.util.Arrays.copyOf(firstArray, firstArray.length + secondArray.length);
+        System.arraycopy(secondArray, 0, result, firstArray.length, secondArray.length);
+        return result;
+    }
+}

src/main/java/nl/devoxist/modulescheduler/console/Formatter.java

@@ -29,12 +29,12 @@
  * {@link java.util.logging.Formatter}.
  *
  * @author Dev-Bjorn
- * @version 1.0.0
+ * @version 1.2.0
  * @see Formatter
  * @since 1.1.0
  */
-public class Formatter extends java.util.logging.Formatter {
-    
+public final class Formatter extends java.util.logging.Formatter {
+
     /**
      * Format the given log record and return the formatted string.
      * <p>

src/main/java/nl/devoxist/modulescheduler/path/PathCyclePrinter.java

@@ -36,10 +36,10 @@
  * dependencies.
  *
  * @author Dev-Bjorn
- * @version 1.1.0
+ * @version 1.2.0
  * @since 1.0.0
  */
-public class PathCyclePrinter extends Thread {
+public final class PathCyclePrinter extends Thread {
     /**
      * The start path of the resolver.
      *

src/main/java/nl/devoxist/modulescheduler/resolvers/DependencyRetriever.java

@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2023 Devoxist, Dev-Bjorn
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package nl.devoxist.modulescheduler.resolvers;
+
+import nl.devoxist.modulescheduler.Module;
+import nl.devoxist.modulescheduler.annotation.Dependency;
+import nl.devoxist.modulescheduler.collection.Arrays;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.stream.Stream;
+
+/**
+ * {@link DependencyRetriever} is an object that is responsible for retrieving the dependencies of the {@link Module}s
+ *
+ * @author Dev-Bjorn
+ * @version 1.2.0
+ * @since 1.2.0
+ */
+public final class DependencyRetriever {
+
+    /**
+     * Construct a new {@link DependencyRetriever} object. This always fails, because the class is a static class.
+     * So it only contains static objects. Thus, it throws an {@link IllegalAccessException}.
+     *
+     * @throws IllegalAccessException If the {@link DependencyRetriever} was try to construct the class. The
+     *                                construction of this class is not possible, because this is a static class.
+     * @since 1.2.0
+     */
+    @Contract(pure = true)
+    private DependencyRetriever() throws IllegalAccessException {
+        throw new IllegalAccessException("This class is a static class, so the construction is not accessible.");
+    }
+
+    /**
+     * Get the dependencies of a {@link Module} class. These dependencies can be retrieved by the {@link Dependency}
+     * annotation or the constructors of the given class.
+     *
+     * @param moduleCls The class of which the dependencies are retrieved from.
+     *
+     * @return The dependencies of the given {@link Module} class. If there is no {@link Dependency} annotation or
+     * constructor present in the given class it will return an empty array of {@link Module} classes.
+     *
+     * @since 1.2.0
+     */
+    public static Class<? extends Module>[] getDependencies(
+            @NotNull Class<? extends Module> moduleCls
+    ) {
+        return Arrays.concatArrays(
+                getDependenciesByAnnotation(moduleCls),
+                getDependenciesByConstructor(moduleCls)
+        );
+    }
+
+
+    /**
+     * Get the dependencies of a {@link Module} class by the parameters of the constructors of the given class.
+     *
+     * @param moduleCls The class of which the dependencies are retrieved from.
+     *
+     * @return The dependencies of the given {@link Module} class. If there are no constructors present in the given
+     * class, the return will be an empty array.
+     *
+     * @since 1.2.0
+     */
+    @SuppressWarnings("unchecked")
+    private static Class<? extends Module> @NotNull [] getDependenciesByConstructor(@NotNull Class<? extends Module> moduleCls) {
+        return (Class<? extends Module>[]) Stream.of(moduleCls.getDeclaredConstructors())
+                .flatMap((declaredConstructor) -> Stream.of(declaredConstructor.getParameterTypes()))
+                .filter(Module.class::isAssignableFrom)
+                .distinct()
+                .toArray(Class<?>[]::new);
+    }
+
+    /**
+     * Get the dependencies of a {@link Module} class by the annotation {@link Dependency}. If the {@link Dependency} is
+     * not present on the class it will return an empty array of {@link Module} classes.
+     *
+     * @param moduleCls The class of which the dependencies are retrieved from.
+     *
+     * @return The dependencies of the given {@link Module} class. If the {@link Dependency} is not present on the class it will
+     * return an empty array of {@link Module} classes.
+     *
+     * @since 1.2.0
+     */
+    @SuppressWarnings("unchecked")
+    private static Class<? extends Module>[] getDependenciesByAnnotation(@NotNull Class<? extends Module> moduleCls) {
+        if (!moduleCls.isAnnotationPresent(Dependency.class)) {
+            return (Class<? extends Module>[]) new Class<?>[0];
+        }
+        Dependency dependency = moduleCls.getAnnotation(Dependency.class);
+        return dependency.value();
+    }
+}

src/main/java/nl/devoxist/modulescheduler/resolvers/ModuleInformationResolver.java

@@ -23,7 +23,6 @@
 package nl.devoxist.modulescheduler.resolvers;
 
 import nl.devoxist.modulescheduler.Module;
-import nl.devoxist.modulescheduler.annotation.Dependency;
 import nl.devoxist.modulescheduler.settings.ModuleInformation;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
@@ -35,7 +34,7 @@
  * ({@link ModuleInformation}).
  *
  * @author Dev-Bjorn
- * @version 1.0.0
+ * @version 1.2.0
  * @since 1.0.0
  */
 public final class ModuleInformationResolver {
@@ -71,7 +70,7 @@ private ModuleInformationResolver() throws IllegalAccessException {
     ) {
         ModuleInformation<?> moduleInformation = getModuleInformation(moduleCls, moduleInformationMap);
 
-        Class<? extends Module>[] dependencies = getDependencies(moduleCls);
+        Class<? extends Module>[] dependencies = DependencyRetriever.getDependencies(moduleCls);
 
         for (Class<? extends Module> dependency : dependencies) {
             addDependsOnInformation(moduleInformation, dependency, moduleInformationMap);
@@ -127,24 +126,4 @@ private static void addDependsOnInformation(
         ModuleInformation<?> dependentModuleInformation = getModuleInformation(dependentOfModule, moduleInformationMap);
         dependentModuleInformation.addDependsOn(moduleInformation);
     }
-
-    /**
-     * Get the dependencies of a {@link Module} class. If the {@link Dependency} is not present on the class it will
-     * return an empty array of {@link Module} classes.
-     *
-     * @param moduleCls The class of which the dependencies are retrieved from.
-     *
-     * @return The dependencies of the given {@link Module} class. If the {@link Dependency} is not present on the class it will
-     * return an empty array of {@link Module} classes.
-     *
-     * @since 1.0.0
-     */
-    @SuppressWarnings("unchecked")
-    private static Class<? extends Module>[] getDependencies(@NotNull Class<? extends Module> moduleCls) {
-        if (!moduleCls.isAnnotationPresent(Dependency.class)) {
-            return (Class<Module>[]) new Class<?>[0];
-        }
-        Dependency dependency = moduleCls.getAnnotation(Dependency.class);
-        return dependency.value();
-    }
 }

src/main/java/nl/devoxist/modulescheduler/runner/StageRunner.java

@@ -37,10 +37,10 @@
  * The process of loading the {@link Module}s.
  *
  * @author Dev-Bjorn
- * @version 1.0.0
+ * @version 1.2.0
  * @since 1.0.0
  */
-public class StageRunner extends Thread {
+public final class StageRunner extends Thread {
     /**
      * The settings of the current running {@link ModuleScheduler}.
      *

src/main/java/nl/devoxist/modulescheduler/settings/ModuleSchedulerInformation.java

@@ -35,10 +35,10 @@
  * {@link ModuleScheduler}.
  *
  * @author Dev-Bjorn
- * @version 1.0.0
+ * @version 1.2.0
  * @since 1.0.0
  */
-public class ModuleSchedulerInformation {
+public final class ModuleSchedulerInformation {
     /**
      * The settings of the current running {@link ModuleScheduler}.
      *

src/main/java/nl/devoxist/modulescheduler/settings/ModuleSchedulerSettings.java

@@ -36,10 +36,10 @@
  * This object gives the options to manipulate the process.
  *
  * @author Dev-Bjorn
- * @version 1.0.0
+ * @version 1.2.0
  * @since 1.0.0
  */
-public class ModuleSchedulerSettings {
+public final class ModuleSchedulerSettings implements Cloneable {
     /**
      * {@link Set} of modules that need to be loaded.
      *