com.codelanx.codelanxlib.listener

Class SubListener<T extends Plugin>

java.lang.Object

com.codelanx.codelanxlib.listener.SubListener<T>

Type Parameters:

T - The specific Plugin to use

All Implemented Interfaces:

Listener

Direct Known Subclasses:

VaultProxyListener

public abstract class SubListener<T extends Plugin>
extends Object
implements Listener

Handles events that are called by Bukkit's event system. On an implementation level, this is relatively the same as Bukkit's Listener class (and even implements said interface), however it also provides methods for simpler registration as well as a simple constructor to ensure a plugin instance is available

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected T	plugin The stored Plugin reference relevant to this SubListener

Constructor Summary

Constructors

Constructor and Description
SubListener(T plugin) Stores the Plugin reference

Method Summary

Modifier and Type	Method and Description
T	getPlugin() Returns the Plugin used for this SubListener
void	onDisable() Called when the plugin is being disabled.
void	register() Registers the listener to the ListenerManager.

Methods inherited from class java.lang.Object

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

Field Detail

plugin

protected final T extends Plugin plugin

The stored Plugin reference relevant to this SubListener

Since:

0.0.1

Constructor Detail

SubListener

public SubListener(T plugin)

Stores the Plugin reference

Parameters:

plugin - The Plugin relevant to this SubListener

Since:

0.0.1

Method Detail

onDisable

public void onDisable()

Called when the plugin is being disabled. This is a convenience method to allow simple cleanup of any resources

Since:

0.1.0

getPlugin

public T getPlugin()

Returns the Plugin used for this SubListener

Returns:

The Plugin that registered this SubListener

Since:

0.1.0

register

public final void register()

Registers the listener to the ListenerManager. If the listener class is already registered, this method will do nothing.

Since:

0.1.0