nl.lockhead.lpf.plugins.plugin

Class Plugin

java.lang.Object

nl.lockhead.lpf.plugins.plugin.Plugin

public abstract class Plugin
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Plugin()

Method Summary

Modifier and Type	Method and Description
void	disable() Disable this plugin, removing any registered event listeners.
void	enable() Enable this plugin, registering its event listeners.
PluginConfig	getConfig()
PluginContainer	getContainer()
int	getId()
protected LPFLogger	getLogger()
boolean	isEnabled()
boolean	isEventsRegistered()
boolean	isLoaded()
protected void	load() Handle further loading of the plugin, after its classes have been loaded.
abstract void	onDisable() Invoked when disabling the plugin
abstract void	onEnable() Invoked when enabling the plugin
void	onLoad() Invoked when loading the plugin
void	onUnload() Invoked when unloading the plugin
protected void	registerEvents() Search for, and register, events in this plugin.
protected void	setContainer(PluginContainer container)
void	unload() Unload this plugin, and unregister its events.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

protected Plugin()

Method Detail

onLoad

public void onLoad()

Invoked when loading the plugin

onUnload

public void onUnload()

Invoked when unloading the plugin

onEnable

public abstract void onEnable()

Invoked when enabling the plugin

onDisable

public abstract void onDisable()

Invoked when disabling the plugin

load

protected final void load()
                   throws InvalidPluginException

Handle further loading of the plugin, after its classes have been loaded.

Throws:

InvalidPluginException - thrown by loadConfig()

registerEvents

protected final void registerEvents()

Search for, and register, events in this plugin.

unload

public final void unload()

Unload this plugin, and unregister its events.

enable

public final void enable()

Enable this plugin, registering its event listeners.

disable

public final void disable()

Disable this plugin, removing any registered event listeners.

isLoaded

public final boolean isLoaded()

isEnabled

public final boolean isEnabled()

isEventsRegistered

public final boolean isEventsRegistered()

getId

public final int getId()

getLogger

protected final LPFLogger getLogger()

getConfig

public PluginConfig getConfig()

getContainer

public PluginContainer getContainer()

setContainer

protected void setContainer(PluginContainer container)