sx.blah.discord.modules.IModule 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 .
 */

package sx.blah.discord.modules;

import sx.blah.discord.api.IDiscordClient;
import sx.blah.discord.api.events.EventSubscriber;
import sx.blah.discord.api.events.IListener;

/**
 * A Discord4J "module".
 *
 * When enabled, modules are registered as event listeners, so your module can use {@link EventSubscriber} or
 * {@link IListener} to listen for events.
 *
 * 
Modules MUST have a default constructor.
 *
 * @see sx.blah.discord.modules Information about module loading.
 */
public interface IModule {

	/**
	 * Called to enable the module. A new instance of the module is created for each call to this method.
	 *
	 * @param client The client the module instance is being enabled for.
	 * @return Whether the module was successfully enabled.
	 */
	boolean enable(IDiscordClient client);

	/**
	 * Called to disable the module.
	 *
	 * It is important that the module implementation attempt to do any and all cleanup in this method in order for
	 * the module to properly unload. The module loader can make no guarantees about the unloading of modules if they
	 * do not properly implement this method.
	 */
	void disable();

	/**
	 * Gets the name of the module.
	 *
	 * @return The name of the module.
	 */
	String getName();

	/**
	 * Gets the author(s) of the module.
	 *
	 * @return The author(s) of the module.
	 */
	String getAuthor();

	/**
	 * Gets the version of the module.
	 *
	 * @return The version of the module.
	 */
	String getVersion();

	/**
	 * Gets the minimum required version of Discord4J for the module to function.
	 *
	 * @return The minimum required version, i.e. "2.8.4".
	 */
	String getMinimumDiscord4JVersion();
}