Release 2.6.0: Major changes to module and command framework

Author: Nikos410

build.gradle

@@ -31,7 +31,7 @@ tasks.withType(JavaCompile) {
     options.encoding = "UTF-8"
 }
 
-version = '2.5.1'
+version = '2.6.0'
 sourceCompatibility = 1.8
 mainClassName = 'de.nikos410.discordbot.DiscordBot'
 

src/main/java/de/nikos410/discordbot/DiscordBot.java

@@ -0,0 +1,49 @@
+package de.nikos410.discordbot.framework;
+
+import de.nikos410.discordbot.DiscordBot;
+
+public abstract class CommandModule {
+    protected DiscordBot bot = null;
+
+    /**
+     * @return Specify the name of this module that is seen by the public. (e.g. when listing commands)
+     */
+    public abstract String getDisplayName();
+
+    /**
+     * @return Provide a brief description of what the module does.
+     */
+    public abstract String getDescription();
+
+    /**
+     * @return Specify whether to register the module with the bot's {@link sx.blah.discord.api.events.EventDispatcher}.
+     * Set this to true if this module is using {@link sx.blah.discord.api.events.EventSubscriber}s.
+     */
+    public boolean hasEvents() {
+        return false;
+    }
+
+    /**
+     * Set the bot field to the current bot instance.
+     *
+     * @param bot The bot instance.
+     */
+    public void setBot(final DiscordBot bot) {
+        this.bot = bot;
+    }
+
+    /**
+     * Gets called when the module is initialized.
+     */
+    public void init() {}
+
+    /**
+     * Gets called when the module is initialized and the bot is ready.
+     */
+    public void initWhenReady() {}
+
+    /**
+     * Gets called when the module is disabled or the bot is shut down
+     */
+    public void shutdown() {}
+}

src/main/java/de/nikos410/discordbot/framework/Command.java

@@ -0,0 +1,114 @@
+package de.nikos410.discordbot.framework;
+
+import java.lang.reflect.Method;
+
+/**
+ * Wrapper class containing the properties for a bot command.
+ */
+public class CommandWrapper {
+    private final String name;
+    private final String help;
+    private final ModuleWrapper module;
+    private final Method method;
+    private final boolean pmAllowed;
+    private final PermissionLevel permissionLevel;
+    private final int expectedParameterCount;
+    private final boolean passContext;
+    private final boolean ignoreParameterCount;
+
+    /**
+     * Create a new command wrapper.
+     *
+     * @param name The name of this command.
+     * @param help The help for this command.
+     * @param module The name of module that contains the command.
+     * @param method The method that should be invoked to execute the command.
+     * @param pmAllowed Set whether the command should be available in private messages.
+     * @param permissionLevel Which permission level is necessary to execute the command.
+     * @param expectedParameterCount The number of parameters the command accepts.
+     * @param passContext Set whether to append additional parameters or to ignore them.
+     * @param ignoreParameterCount Don't check if enough parameters are given when executing.
+     */
+    public CommandWrapper(final String name,
+                          final String help,
+                          final ModuleWrapper module,
+                          final Method method,
+                          final boolean pmAllowed,
+                          final PermissionLevel permissionLevel,
+                          final int expectedParameterCount,
+                          final boolean passContext,
+                          final boolean ignoreParameterCount) {
+        this.name = name;
+        this.help = help;
+        this.module = module;
+        this.method = method;
+        this.pmAllowed = pmAllowed;
+        this.permissionLevel = permissionLevel;
+        this.expectedParameterCount = expectedParameterCount;
+        this.passContext = passContext;
+        this.ignoreParameterCount = ignoreParameterCount;
+    }
+
+    /**
+     * @return The name of this command.
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * @return The help for this command.
+     */
+    public String getHelp() {
+        return help;
+    }
+
+    /**
+     * @return The name of the module that contains this command.
+     */
+    public ModuleWrapper getModule() {
+        return module;
+    }
+
+    /**
+     * @return The method that should be invoked to execute the command.
+     */
+    public Method getMethod() {
+        return method;
+    }
+
+    /**
+     * @return True if the command should be available in private messages.
+     */
+    public boolean isPmAllowed() {
+        return pmAllowed;
+    }
+
+    /**
+     * @return The permission level that is necessary to execute the command.
+     */
+    public PermissionLevel getPermissionLevel() {
+        return permissionLevel;
+    }
+
+    /**
+     * @return The number of parameters the command accepts.
+     */
+    public int getExpectedParameterCount() {
+        return expectedParameterCount;
+    }
+
+    /**
+     * @return True if additional parameters should be appended to the last one or ignored.
+     */
+    public boolean isPassContext() {
+        return passContext;
+    }
+
+    /**
+     * @return True if the parameter count check should be ignored.
+     */
+    public boolean isIgnoreParameterCount() {
+        return ignoreParameterCount;
+    }
+}

src/main/java/de/nikos410/discordbot/framework/CommandModule.java

@@ -0,0 +1,90 @@
+package de.nikos410.discordbot.framework;
+
+import java.util.List;
+
+/**
+ * Wrapper class containing a bot module's instance and a list of all commands in this module.
+ */
+public class ModuleWrapper {
+    private final Class<? extends CommandModule> moduleClass;
+    private final String name;
+
+    private String displayName;
+    private String description;
+    private CommandModule instance;
+    private List<CommandWrapper> commands;
+    private ModuleStatus status;
+
+    public ModuleWrapper(final Class<? extends CommandModule> moduleClass) {
+        this.moduleClass = moduleClass;
+        this.name = moduleClass.getSimpleName();
+    }
+
+    public Class<? extends CommandModule> getModuleClass() {
+        return moduleClass;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDisplayName() {
+        return displayName;
+    }
+
+    public void setDisplayName(final String displayName) {
+        this.displayName = displayName;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    public CommandModule getInstance() {
+        return instance;
+    }
+
+    public void setInstance(final CommandModule instance) {
+        this.instance = instance;
+    }
+
+    public List<CommandWrapper> getCommands() {
+        return commands;
+    }
+
+    public void setCommands(final List<CommandWrapper> commands) {
+        this.commands = commands;
+    }
+
+    public ModuleStatus getStatus() {
+        return status;
+    }
+
+    public void setStatus(final ModuleStatus status) {
+        this.status = status;
+    }
+
+    /**
+     * Enum for specifying the current status of a module.
+     */
+    public enum ModuleStatus {
+        /**
+         * The module is loaded, it's features are available.
+         */
+        ACTIVE,
+
+        /**
+         * The module is not loaded, it's features are not available.
+         */
+        INACTIVE,
+
+        /**
+         * The module could not be loaded.
+         */
+        FAILED,
+    }
+}

src/main/java/de/nikos410/discordbot/framework/CommandWrapper.java

@@ -2,10 +2,10 @@
 
 import de.nikos410.discordbot.framework.PermissionLevel;
 
-import java.lang.annotation.Target;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)