Module Scheduler

Getting Started

How to install this API? For all possible options to install this API maven central and select the version.

Maven

Add this to your pom.xml.

<dependency>
    <groupId>nl.devoxist</groupId>
    <artifactId>module-scheduler</artifactId>
    <version>1.2.0</version>
</dependency>

Usage

This API can be used to automatically order tasks/modules in the correct order.

How to use this API?

Firstly create as class that implements ModuleScheduler. This is the controller of all the modules.

public class ModuleSchedulerProcess implements ModuleScheduler {

    @Override
    public void updateSettings(@NotNull ModuleSchedulerSettings settings) {
    }


    @Override
    public void beforeModuleExecute(Module module) {
        // Put here your stuff
    }

    @Override
    public void afterModuleExecute(Module module) {
        // Put here your stuff
    }
}

Then you want to add some modules to the controllers. The modules can be created by implementing Module.

public class ModuleA implements Module {

    @Override
    public void onExecute() {
        // Put here your stuff
    }
}

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.

@Dependency(ModuleA.class)
public class ModuleB implements Module {

    public ModuleB(ModuleA moduleA) {
        // Put here your stuff
    }


    @Override
    public void onExecute() {
        // Put here your stuff
    }
}

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.

@Dependency({ModuleB.class, ModuleA.class})
public class ModuleC implements Module {

    public ModuleC(ModuleA moduleA) {
        // Put here your stuff
    }

    public ModuleC(ModuleB moduleB) {
        // Put here your stuff
    }

    @Override
    public void onExecute() {
        // Put here your stuff
    }
}

How to add modules to the controller, the scheduler? This can be done to change the content of the method, ModuleScheduler#updateSettings. Add a line with ModuleSchedulerSettings#addModule. It is important to add all the tasks/modules that need to be loaded. Only the modules that are added can be loaded.

    @Override
    public void updateSettings(@NotNull ModuleSchedulerSettings settings){
        settings.addModule(ModuleA.class);
        settings.addModule(ModuleB.class);
        settings.addModule(ModuleC.class);
    }

How to start the process? Construct the Scheduler class with the inherited ModuleScheduler that you want to load. After calling this construction the modules will automatically be runned in correct order. These methods will run, when a module is being executed, in the following order ModuleScheduler#beforeModuleExecute -> Module#onExecute -> ModuleScheduler#afterModuleExecute.

new Scheduler(new ModuleSchedulerProcess());

Module Scheduler Settings

Modules

The modules which are going to be loaded can be added through the ModuleSchedulerSettings#addModule method. The modules can be added through their class path or their Class.

Input Registers

The registers that are used in to construct the modules. These modules need to have a constructor with the parameters types registered in the input registries and/or can be the modules that are loaded. These registries can be registered through the ModuleSchedulerSettings#addRegisters method. Note: The modules that are getting loaded do not have to be registered in the input registers.

Output Register

This is a register that contains the constructed modules that are loaded inside the loading process.

Logger

This is the logger of the process that is going to be used to output the messages of process.

Contributors

Dev-Bjorn

Devoxist/ModuleScheduler