Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.event.HandlerList Class Reference

A list of event handlers, stored per-event. More...

Public Member Functions

 HandlerList ()
 Create a new handler list and initialize using EventPriority The HandlerList is then added to meta-list for use in bakeAll()
 
synchronized void register (RegisteredListener listener)
 Register a new listener in this handler list.
 
void registerAll (Collection< RegisteredListener > listeners)
 Register a collection of new listeners in this handler list.
 
synchronized void unregister (RegisteredListener listener)
 Remove a listener from a specific order slot.
 
synchronized void unregister (Plugin plugin)
 Remove a specific plugin's listeners from this handler.
 
synchronized void unregister (Listener listener)
 Remove a specific listener from this handler.
 
synchronized void bake ()
 Bake HashMap and ArrayLists to 2d array - does nothing if not necessary.
 
RegisteredListener[] getRegisteredListeners ()
 Get the baked registered listeners associated with this handler list.
 

Static Public Member Functions

static void bakeAll ()
 Bake all handler lists.
 
static void unregisterAll ()
 Unregister all listeners from all handler lists.
 
static void unregisterAll (Plugin plugin)
 Unregister a specific plugin's listeners from all handler lists.
 
static void unregisterAll (Listener listener)
 Unregister a specific listener from all handler lists.
 
static ArrayList
< RegisteredListener
getRegisteredListeners (Plugin plugin)
 Get a specific plugin's registered listeners associated with this handler list.
 
static ArrayList< HandlerListgetHandlerLists ()
 Get a list of all handler lists for every event type.
 

Detailed Description

A list of event handlers, stored per-event.

Based on lahwran's fevents.

Definition at line 12 of file HandlerList.java.

Constructor & Destructor Documentation

org.bukkit.event.HandlerList.HandlerList ( )

Create a new handler list and initialize using EventPriority The HandlerList is then added to meta-list for use in bakeAll()

Definition at line 89 of file HandlerList.java.

Member Function Documentation

synchronized void org.bukkit.event.HandlerList.bake ( )

Bake HashMap and ArrayLists to 2d array - does nothing if not necessary.

Definition at line 172 of file HandlerList.java.

Referenced by org.bukkit.event.HandlerList.getRegisteredListeners().

static void org.bukkit.event.HandlerList.bakeAll ( )
static

Bake all handler lists.

Best used just after all normal event registration is complete, ie just after all plugins are loaded if you're using fevents in a plugin system.

Definition at line 35 of file HandlerList.java.

Referenced by org.bukkit.plugin.SimplePluginManager.enablePlugin().

static ArrayList<HandlerList> org.bukkit.event.HandlerList.getHandlerLists ( )
static

Get a list of all handler lists for every event type.

Returns
the list of all handler lists

Definition at line 223 of file HandlerList.java.

Referenced by org.bukkit.command.defaults.TimingsCommand.execute().

RegisteredListener [] org.bukkit.event.HandlerList.getRegisteredListeners ( )

Get the baked registered listeners associated with this handler list.

Returns
the array of registered listeners

Definition at line 186 of file HandlerList.java.

References org.bukkit.event.HandlerList.bake().

Referenced by org.bukkit.command.defaults.TimingsCommand.execute().

static ArrayList<RegisteredListener> org.bukkit.event.HandlerList.getRegisteredListeners ( Plugin  plugin)
static

Get a specific plugin's registered listeners associated with this handler list.

Parameters
pluginthe plugin to get the listeners of
Returns
the list of registered listeners

Definition at line 199 of file HandlerList.java.

synchronized void org.bukkit.event.HandlerList.register ( RegisteredListener  listener)

Register a new listener in this handler list.

Parameters
listenerlistener to register

Definition at line 104 of file HandlerList.java.

Referenced by org.bukkit.plugin.SimplePluginManager.registerEvent().

void org.bukkit.event.HandlerList.registerAll ( Collection< RegisteredListener listeners)

Register a collection of new listeners in this handler list.

Parameters
listenerslisteners to register

Definition at line 116 of file HandlerList.java.

Referenced by org.bukkit.plugin.SimplePluginManager.registerEvents().

synchronized void org.bukkit.event.HandlerList.unregister ( RegisteredListener  listener)

Remove a listener from a specific order slot.

Parameters
listenerlistener to remove

Definition at line 127 of file HandlerList.java.

References org.bukkit.plugin.RegisteredListener.getPriority().

synchronized void org.bukkit.event.HandlerList.unregister ( Plugin  plugin)

Remove a specific plugin's listeners from this handler.

Parameters
pluginplugin to remove

Definition at line 138 of file HandlerList.java.

synchronized void org.bukkit.event.HandlerList.unregister ( Listener  listener)

Remove a specific listener from this handler.

Parameters
listenerlistener to remove

Definition at line 156 of file HandlerList.java.

static void org.bukkit.event.HandlerList.unregisterAll ( )
static

Unregister all listeners from all handler lists.

Definition at line 46 of file HandlerList.java.

Referenced by org.bukkit.plugin.SimplePluginManager.clearPlugins(), and org.bukkit.plugin.SimplePluginManager.disablePlugin().

static void org.bukkit.event.HandlerList.unregisterAll ( Plugin  plugin)
static

Unregister a specific plugin's listeners from all handler lists.

Parameters
pluginplugin to unregister

Definition at line 64 of file HandlerList.java.

static void org.bukkit.event.HandlerList.unregisterAll ( Listener  listener)
static

Unregister a specific listener from all handler lists.

Parameters
listenerlistener to unregister

Definition at line 77 of file HandlerList.java.


The documentation for this class was generated from the following file: