sx.blah.discord.modules.package-info Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of Discord4J Show documentation
The newest version!
/*
 *     This file is part of Discord4J.
 *
 *     Discord4J is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     Discord4J is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with Discord4J.  If not, see .
 */

/**
 * This package contains everything relating to Discord4J "modules". Modules are like addons to Discord4J. They add
 * additional, optional features. While bots aren't required to use this module system, it is recommended as it allows
 * for multiple bots to work at the same time.
 * 
 * There are two stages to module loading:
 * 

 * First, the class loading. If a jar file's MANIFEST.MF includes the Discord4J-ModuleClass attribute, then
 * the module loader will load only that class and skip the recursive search. If there is more than one IModule
 * implementation in the jar, then the classes should be listed, separated by a semicolon ";". This method is
 * recommended as it saves on loading overhead. When Discord4J searches for a class implementing
 * {@link sx.blah.discord.modules.IModule}, it will first check the jar file's MANIFEST.MF for the
 * Module-Requires attribute. If the attribute exists, Discord4J will attempt to load a jar file containing
 * a class which corresponds to the value of that attribute first, preventing any class loading errors
 * (NOTE: Module-Requires must be in the form "package.name.ClassName". Multiple classes can be specified
 * by separating them with semicolons).
 * 
 * Second, the instance loading. When a new {@link sx.blah.discord.api.IDiscordClient IDiscordClient} is created, its
 * {@link sx.blah.discord.modules.ModuleLoader} instance will attempt to enable all class-loaded modules. In order to do
 * this, the module loader first verifies that the module is compatible with the current Discord4J version by creating
 * a new instance using a default constructor (constructor with no args) and then comparing the current
 * {@link sx.blah.discord.Discord4J#VERSION version} with the
 * {@link sx.blah.discord.modules.IModule#getMinimumDiscord4JVersion() module's minimum version}. If that check passes,
 * the module is then registered as an event listener and its
 * {@link sx.blah.discord.modules.IModule#enable(sx.blah.discord.api.IDiscordClient)} method is called.
 */
package sx.blah.discord.modules;