Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.plugin.PluginLoader Interface Reference
Inheritance diagram for org.bukkit.plugin.PluginLoader:
org.bukkit.plugin.java.JavaPluginLoader

Public Member Functions

Plugin loadPlugin (File file) throws InvalidPluginException, UnknownDependencyException
 
PluginDescriptionFile getPluginDescription (File file) throws InvalidDescriptionException
 
Pattern[] getPluginFileFilters ()
 
Map< Class<?extends Event >, Set< RegisteredListener > > createRegisteredListeners (Listener listener, Plugin plugin)
 
void enablePlugin (Plugin plugin)
 
void disablePlugin (Plugin plugin)
 

Detailed Description

Represents a plugin loader, which handles direct access to specific types of plugins

Definition at line 15 of file PluginLoader.java.

Member Function Documentation

Map<Class<? extends Event>, Set<RegisteredListener> > org.bukkit.plugin.PluginLoader.createRegisteredListeners ( Listener  listener,
Plugin  plugin 
)

Creates and returns registered listeners for the event classes used in this listener

Parameters
listenerThe object that will handle the eventual call back
pluginThe plugin to use when creating registered listeners
Returns
The registered listeners.

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

void org.bukkit.plugin.PluginLoader.disablePlugin ( Plugin  plugin)

Disables the specified plugin

Attempting to disable a plugin that is not enabled will have no effect

Parameters
pluginPlugin to disable

Implemented in org.bukkit.plugin.java.JavaPluginLoader.

void org.bukkit.plugin.PluginLoader.enablePlugin ( Plugin  plugin)

Enables the specified plugin

Attempting to enable a plugin that is already enabled will have no effect

Parameters
pluginPlugin to enable
PluginDescriptionFile org.bukkit.plugin.PluginLoader.getPluginDescription ( File  file) throws InvalidDescriptionException

Loads a PluginDescriptionFile from the specified file

Parameters
fileFile to attempt to load from
Returns
A new PluginDescriptionFile loaded from the plugin.yml in the specified file
Exceptions
InvalidDescriptionExceptionIf the plugin description file could not be created

Implemented in org.bukkit.plugin.java.JavaPluginLoader.

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

Pattern [] org.bukkit.plugin.PluginLoader.getPluginFileFilters ( )

Returns a list of all filename filters expected by this PluginLoader

Returns
The filters

Implemented in org.bukkit.plugin.java.JavaPluginLoader.

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

Plugin org.bukkit.plugin.PluginLoader.loadPlugin ( File  file) throws InvalidPluginException, UnknownDependencyException

Loads the plugin contained in the specified file

Parameters
fileFile to attempt to load
Returns
Plugin that was contained in the specified file, or null if unsuccessful
Exceptions
InvalidPluginExceptionThrown when the specified file is not a plugin
UnknownDependencyExceptionIf a required dependency could not be found

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


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