dev.siris.module

Class ModuleManager

java.lang.Object

dev.siris.module.ModuleManager

public class ModuleManager
extends Object

A class which deals with the enabling, disabling, loading and unloading. of Module's.

Author:

Siris

Constructor Summary

Constructors

Constructor and Description
ModuleManager(org.bukkit.plugin.java.JavaPlugin plugin)
ModuleManager(org.bukkit.plugin.java.JavaPlugin plugin, String moduleDir)

Method Summary

Modifier and Type	Method and Description
void	disableModule(@NotNull Module module) Disables the given module.
void	disableModule(@NotNull String name) Disables a module with the given name.
void	disableModules() Disables all loaded modules.
void	enableModule(@NotNull Module module) Enables the given module.
void	enableModule(@NotNull String name) Enables the module with name.
void	enableModules() Enables all the loaded modules.
protected org.bukkit.command.CommandMap	getCommandMap()
@Nullable Module	getDisabledModule(Module module) Gets the module (disabled)
@Nullable Module	getDisabledModule(String name) Gets the module with name (disabled)
@NotNull List<Module>	getDisabledModules() Gets all the inactive modules from this manager.
@Nullable Module	getEnabledModule(String name) Gets the enabled module with the given name.
@NotNull List<Module>	getEnabledModules() Gets all the active modules from this manager.
File	getModuleFolder()
@NotNull List<Module>	getModules() Gets all modules loaded by the manager.
boolean	hasDisabledModule(Module module) Checks to see if the given module is disabled.
boolean	hasDisabledModule(String name) Checks to see if the given module is disabled.
boolean	hasEnabledModule(Module module) Returns whether the given module is loaded.
boolean	hasEnabledModule(String name) Returns whether the given module with name is loaded.
<T extends Module> void	loadModuleFromClass(@NotNull String name, Class<T> clazz) Loads the modules from the given class.
protected void	loadModuleJar(File file)
void	loadModules()
void	reloadModule(@NotNull Module module) Reloads the given module.
void	reloadModule(@NotNull String name) Reloads a given module with the name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleManager

public ModuleManager(org.bukkit.plugin.java.JavaPlugin plugin)

ModuleManager

public ModuleManager(org.bukkit.plugin.java.JavaPlugin plugin,
                     String moduleDir)

Method Detail

loadModuleFromClass

public <T extends Module> void loadModuleFromClass(@NotNull
                                                   @NotNull String name,
                                                   Class<T> clazz)

Loads the modules from the given class.

Type Parameters:

T - Any object that is, or subclasses Module.

Parameters:

name - The name to be used for the module.

clazz - The class of the Module

loadModules

public void loadModules()

loadModuleJar

protected void loadModuleJar(File file)

enableModules

public void enableModules()

Enables all the loaded modules. This should be called after loadModuleFromClass(String, Class)

disableModule

public void disableModule(@NotNull
                          @NotNull Module module)

Disables the given module.

Parameters:

module - The module to disable.

disableModule

public void disableModule(@NotNull
                          @NotNull String name)

Disables a module with the given name.

Parameters:

name - The name of the module to disable.

disableModules

public void disableModules()

Disables all loaded modules.

enableModule

public void enableModule(@NotNull
                         @NotNull Module module)

Enables the given module.

Parameters:

module - The module to be enabled.

enableModule

public void enableModule(@NotNull
                         @NotNull String name)

Enables the module with name.

Parameters:

name - The name of the module to enable.

getEnabledModule

@Nullable
public @Nullable Module getEnabledModule(String name)

Gets the enabled module with the given name.

Parameters:

name - The name of the module.

Returns:

The Module with the given name.

getDisabledModule

@Nullable
public @Nullable Module getDisabledModule(Module module)

Gets the module (disabled)

Parameters:

module - The module to get.

Returns:

The found module.

getDisabledModule

@Nullable
public @Nullable Module getDisabledModule(String name)

Gets the module with name (disabled)

Parameters:

name - The module with name to get.

Returns:

The found module.

hasDisabledModule

public boolean hasDisabledModule(Module module)

Checks to see if the given module is disabled.

Parameters:

module - The module to check if disabled.

Returns:

true if disabled, false otherwise.

hasDisabledModule

public boolean hasDisabledModule(String name)

Checks to see if the given module is disabled.

Parameters:

name - The name of the module to check if disabled.

Returns:

true if disabled, false otherwise.

reloadModule

public void reloadModule(@NotNull
                         @NotNull Module module)

Reloads the given module.

Parameters:

module - The module to reload. Note that the module must be enabled in order to reload.

reloadModule

public void reloadModule(@NotNull
                         @NotNull String name)

Reloads a given module with the name. Note that the module must be enabled in order to reload.

Parameters:

name - The name of the module to reload.

hasEnabledModule

public boolean hasEnabledModule(Module module)

Returns whether the given module is loaded.

Parameters:

module - The module to check for.

Returns:

true if loaded false, otherwise.

hasEnabledModule

public boolean hasEnabledModule(String name)

Returns whether the given module with name is loaded.

Parameters:

name - The name of the module to check for.

Returns:

true if loaded false, otherwise.

getCommandMap

protected org.bukkit.command.CommandMap getCommandMap()

getModules

@NotNull
public @NotNull List<Module> getModules()

Gets all modules loaded by the manager.

Returns:

A list of all loaded modules.

getModuleFolder

public File getModuleFolder()

getEnabledModules

@NotNull
public @NotNull List<Module> getEnabledModules()

Gets all the active modules from this manager.

Returns:

A list of enabled modules.

getDisabledModules

@NotNull
public @NotNull List<Module> getDisabledModules()

Gets all the inactive modules from this manager.

Returns:

A list of disabled managers.