com.codelanx.codelanxlib.listener

Class ListenerManager

java.lang.Object

com.codelanx.codelanxlib.listener.ListenerManager

public final class ListenerManager
extends Object

Centrally holds references to different Listener classes to allow for retrieval of SubListener references

Since:

0.0.1

Version:

0.1.0

Author:

1Rogue

Method Summary

Modifier and Type	Method and Description
static <S extends SubListener<? extends Plugin>> S	getListener(Class<S> listener) Gets a listener by its string name.
static <P extends Plugin,S extends SubListener<P>> P	getRegisteringPlugin(Class<S> listener) Returns the Plugin relevant to the passed SubListener class
static <T extends SubListener<?>> boolean	isRegistered(Class<T> listener) Returns whether or not a listener is registered under the relevant listener key
static boolean	isRegisteredToBukkit(Plugin p, Listener l) Returns true if the passed Listener has another Listener of the same class type already registered for bukkit.
static <T extends Event> void	listen(Class<T> clazz, Consumer<T> event) Allows registering an anonymous listener for any bukkit listeners using Java 8's function API, useful for listening to events in one-liner solutions
static <S extends SubListener<?>> S	registerListener(S listener) Registers a listener through Bukkit and ListenerManager
static <T extends SubListener<?>> void	registerListeners(T... listeners) Calls registerListener(SubListener) for every passed listener.
static void	release() Unregisters all the listeners attached to this ListenerManager.
static void	unregisterListener(Class<? extends SubListener<?>> listener) Unregisters a specific SubListener from both CodelanxLib and Bukkit

Methods inherited from class java.lang.Object

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

Method Detail

getListener

public static <S extends SubListener<? extends Plugin>> S getListener(Class<S> listener)

Gets a listener by its string name. Returns null if the listener is disabled or not registered.

Type Parameters:

S - The SubListener type

Parameters:

listener - An instance of the class type to retrieve

Returns:

The listener class, null if disabled or not registered

Throws:

IllegalArgumentException - If the listener isn't registered

Since:

0.0.1

getRegisteringPlugin

public static <P extends Plugin,S extends SubListener<P>> P getRegisteringPlugin(Class<S> listener)

Returns the Plugin relevant to the passed SubListener class

Type Parameters:

P - The Plugin type

S - The SubListener type

Parameters:

listener - The SubListener class that was registered

Returns:

The Plugin that registered the SubListener

Throws:

IllegalArgumentException - If the listener isn't registered

Since:

0.1.0

isRegistered

public static <T extends SubListener<?>> boolean isRegistered(Class<T> listener)

Returns whether or not a listener is registered under the relevant listener key

Type Parameters:

T - The SubListener class to get

Parameters:

listener - The listener class to look for

Returns:

true if registered, false otherwise

Since:

0.0.1

isRegisteredToBukkit

public static boolean isRegisteredToBukkit(Plugin p,
                                           Listener l)

Returns true if the passed Listener has another Listener of the same class type already registered for bukkit. This should not be used with any listeners that are from an anonymous class, as this will return true for any other anonymous classes as well

Parameters:

p - The Plugin that registers this Listener

l - The Listener to check

Returns:

true if registered to bukkit

Since:

0.1.0

registerListener

public static <S extends SubListener<?>> S registerListener(S listener)

Registers a listener through Bukkit and ListenerManager

Type Parameters:

S - The SubListener class to register

Parameters:

listener - The listener to register

Returns:

The listener that was registered

Throws:

IllegalArgumentException - Attempted to register a Listener twice

Since:

0.0.1

registerListeners

public static <T extends SubListener<?>> void registerListeners(T... listeners)

Calls registerListener(SubListener) for every passed listener. Any exception thrown will be re-thrown after all listeners are registered

Type Parameters:

T - The SubListener class to register

Parameters:

listeners - The listeners to register

Throws:

IllegalArgumentException - Attempted to register a Listener twice

Since:

0.0.1

unregisterListener

public static void unregisterListener(Class<? extends SubListener<?>> listener)

Unregisters a specific SubListener from both CodelanxLib and Bukkit

Parameters:

listener - The SubListener class to unregister

Since:

0.1.0

release

public static void release()

Unregisters all the listeners attached to this ListenerManager. Can only be called from CodelanxLib

Throws:

com.codelanx.commons.util.exception.IllegalInvocationException - Only CodelanxLib can use

Since:

0.0.1

listen

public static <T extends Event> void listen(Class<T> clazz,
                                            Consumer<T> event)

Allows registering an anonymous listener for any bukkit listeners using Java 8's function API, useful for listening to events in one-liner solutions

Type Parameters:

T - The type of the Event

Parameters:

clazz - The Event fired within Bukkit to listen to

event - A Consumer of the event, called when the event is fired

Since:

0.2.0