dev.siris.module

Class Module

java.lang.Object

dev.siris.module.Module

All Implemented Interfaces:

org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

public class Module
extends Object
implements org.bukkit.plugin.Plugin

Allows for Modularization of components.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.bukkit.plugin.PluginDescriptionFile	description
protected boolean	jarLoaded

Constructor Summary

Constructors

Constructor and Description
Module()

Method Summary

Modifier and Type	Method and Description
@Nullable ModuleCommand	getCommand(@NotNull String name) Gets the command with the given name, specific to this plugin.
@NotNull org.bukkit.configuration.file.FileConfiguration	getConfig()
@NotNull File	getDataFolder()
org.bukkit.generator.ChunkGenerator	getDefaultWorldGenerator(@NotNull String worldName, String id)
@NotNull org.bukkit.plugin.PluginDescriptionFile	getDescription()
@NotNull Logger	getLogger()
InputStream	getModuleFile()
@NotNull String	getName()
org.bukkit.plugin.java.JavaPlugin	getOwner() Gets the owning plugin of the module.
@Nullable org.bukkit.command.PluginCommand	getOwnerCommand(@NotNull String name)
@NotNull org.bukkit.plugin.PluginLoader	getPluginLoader()
InputStream	getResource(@NotNull String resourcePath)
@NotNull org.bukkit.Server	getServer()
protected void	init(org.bukkit.plugin.java.JavaPlugin owner, String name, @NotNull ModuleManager manager)
boolean	isEnabled()
boolean	isJarLoaded()
boolean	isNaggable()
boolean	onCommand(@NotNull org.bukkit.command.CommandSender commandSender, @NotNull org.bukkit.command.Command command, @NotNull String s, @NotNull String[] args)
void	onDisable()
void	onEnable()
void	onLoad()
List<String>	onTabComplete(@NotNull org.bukkit.command.CommandSender sender, @NotNull org.bukkit.command.Command command, @NotNull String alia, @NotNull String[] args)
void	reloadConfig()
void	saveConfig()
void	saveDefaultConfig()
void	saveResource(@NotNull String resourcePath, boolean replace)
void	setDescription(org.bukkit.plugin.PluginDescriptionFile description)
void	setEnabled(boolean enabled) Sets the Module to be enabled or not.
protected void	setJarLoaded(boolean jarLoaded)
void	setNaggable(boolean canNag)

Methods inherited from class java.lang.Object

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

Field Detail

description

protected org.bukkit.plugin.PluginDescriptionFile description

jarLoaded

protected boolean jarLoaded

Constructor Detail

Module

public Module()

Method Detail

init

protected void init(org.bukkit.plugin.java.JavaPlugin owner,
                    String name,
                    @NotNull
                    @NotNull ModuleManager manager)

getDataFolder

@NotNull
public @NotNull File getDataFolder()

Specified by:

getDataFolder in interface org.bukkit.plugin.Plugin

getDescription

@NotNull
public @NotNull org.bukkit.plugin.PluginDescriptionFile getDescription()

Specified by:

getDescription in interface org.bukkit.plugin.Plugin

getConfig

@NotNull
public @NotNull org.bukkit.configuration.file.FileConfiguration getConfig()

Specified by:

getConfig in interface org.bukkit.plugin.Plugin

getResource

public InputStream getResource(@NotNull
                               @NotNull String resourcePath)

Specified by:

getResource in interface org.bukkit.plugin.Plugin

saveConfig

public void saveConfig()

Specified by:

saveConfig in interface org.bukkit.plugin.Plugin

saveDefaultConfig

public void saveDefaultConfig()

Specified by:

saveDefaultConfig in interface org.bukkit.plugin.Plugin

saveResource

public void saveResource(@NotNull
                         @NotNull String resourcePath,
                         boolean replace)

Specified by:

saveResource in interface org.bukkit.plugin.Plugin

reloadConfig

public void reloadConfig()

Specified by:

reloadConfig in interface org.bukkit.plugin.Plugin

getPluginLoader

@NotNull
public @NotNull org.bukkit.plugin.PluginLoader getPluginLoader()

Specified by:

getPluginLoader in interface org.bukkit.plugin.Plugin

getServer

@NotNull
public @NotNull org.bukkit.Server getServer()

Specified by:

getServer in interface org.bukkit.plugin.Plugin

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface org.bukkit.plugin.Plugin

setEnabled

public final void setEnabled(boolean enabled)

Sets the Module to be enabled or not.

Parameters:

enabled - The enable state to set.

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

onLoad

public void onLoad()

Specified by:

onLoad in interface org.bukkit.plugin.Plugin

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

isNaggable

public boolean isNaggable()

Specified by:

isNaggable in interface org.bukkit.plugin.Plugin

setNaggable

public void setNaggable(boolean canNag)

Specified by:

setNaggable in interface org.bukkit.plugin.Plugin

getDefaultWorldGenerator

public org.bukkit.generator.ChunkGenerator getDefaultWorldGenerator(@NotNull
                                                                    @NotNull String worldName,
                                                                    String id)

Specified by:

getDefaultWorldGenerator in interface org.bukkit.plugin.Plugin

getLogger

@NotNull
public @NotNull Logger getLogger()

Specified by:

getLogger in interface org.bukkit.plugin.Plugin

getName

@NotNull
public @NotNull String getName()

Specified by:

getName in interface org.bukkit.plugin.Plugin

onCommand

public boolean onCommand(@NotNull
                         @NotNull org.bukkit.command.CommandSender commandSender,
                         @NotNull
                         @NotNull org.bukkit.command.Command command,
                         @NotNull
                         @NotNull String s,
                         @NotNull
                         @NotNull String[] args)

Specified by:

onCommand in interface org.bukkit.command.CommandExecutor

getCommand

@Nullable
public @Nullable ModuleCommand getCommand(@NotNull
                                                    @NotNull String name)

Gets the command with the given name, specific to this plugin. Commands need to be registered in the PluginDescriptionFile to exist at runtime.

Parameters:

name - name or alias of the command

Returns:

the module command if found, otherwise null

getOwnerCommand

@Nullable
public @Nullable org.bukkit.command.PluginCommand getOwnerCommand(@NotNull
                                                                            @NotNull String name)

onTabComplete

public List<String> onTabComplete(@NotNull
                                  @NotNull org.bukkit.command.CommandSender sender,
                                  @NotNull
                                  @NotNull org.bukkit.command.Command command,
                                  @NotNull
                                  @NotNull String alia,
                                  @NotNull
                                  @NotNull String[] args)

Specified by:

onTabComplete in interface org.bukkit.command.TabCompleter

getOwner

public final org.bukkit.plugin.java.JavaPlugin getOwner()

Gets the owning plugin of the module.

Returns:

The owning plugin.

getModuleFile

public InputStream getModuleFile()

setDescription

public void setDescription(org.bukkit.plugin.PluginDescriptionFile description)

isJarLoaded

public boolean isJarLoaded()

setJarLoaded

protected void setJarLoaded(boolean jarLoaded)