net.md_5.bungee.api.plugin

Class Plugin

java.lang.Object

net.md_5.bungee.api.plugin.Plugin

public class Plugin
extends Object

Represents any Plugin that may be loaded at runtime to enhance existing functionality.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Plugin()
protected	Plugin(ProxyServer proxy, PluginDescription description)

Method Summary

Modifier and Type	Method and Description
Configuration	getConfig() Gets the default configuration
File	getDataFolder() Gets the data folder where this plugin may store arbitrary data.
PluginDescription	getDescription()
ExecutorService	getExecutorService() Deprecated.
File	getFile()
Logger	getLogger()
ProxyServer	getProxy()
InputStream	getResourceAsStream(String name) Get a resource from within this plugins jar or container.
org.slf4j.Logger	getSLF4JLogger()
boolean	isEnabled() Returns whenever this plugin is enabled.
void	loadConfig(Class<? extends ConfigurationProvider> configType) (Re)loads a default config.
void	onDisable() Called when this plugin is disabled.
void	onEnable() Called when this plugin is enabled.
void	onLoad() Called when the plugin has just been loaded.
void	saveConfig() Saves the configuration changes (if have)

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin()

Plugin

protected Plugin(ProxyServer proxy,
                 PluginDescription description)

Method Detail

getSLF4JLogger

public org.slf4j.Logger getSLF4JLogger()

onLoad

public void onLoad()

Called when the plugin has just been loaded. Most of the proxy will not be initialized, so only use it for registering ConfigurationAdapter's and other predefined behavior.

onEnable

public void onEnable()

Called when this plugin is enabled.

onDisable

public void onDisable()

Called when this plugin is disabled.

loadConfig

public void loadConfig(Class<? extends ConfigurationProvider> configType)

(Re)loads a default config.

Parameters:

configType - type of the config, which should be supported by default

getConfig

public Configuration getConfig()

Gets the default configuration

Returns:

configuration

Throws:

IllegalArgumentException - if config not loaded

saveConfig

public void saveConfig()

Saves the configuration changes (if have)

Throws:

IllegalArgumentException - if config not loaded

getDataFolder

public final File getDataFolder()

Gets the data folder where this plugin may store arbitrary data. It will be a child of ProxyServer.getPluginsFolder().

Returns:

the data folder of this plugin

getResourceAsStream

public final InputStream getResourceAsStream(String name)

Get a resource from within this plugins jar or container. Care must be taken to close the returned stream.

Parameters:

name - the full path name of this resource

Returns:

the stream for getting this resource, or null if it does not exist

isEnabled

public boolean isEnabled()

Returns whenever this plugin is enabled.

Returns:

true if enabled

getExecutorService

@Deprecated
public ExecutorService getExecutorService()

Deprecated.

getDescription

public PluginDescription getDescription()

getProxy

public ProxyServer getProxy()

getFile

public File getFile()

getLogger

public Logger getLogger()