Represents a Java plugin. More...

Inheritance diagram for org.bukkit.plugin.java.JavaPlugin:

Collaboration diagram for org.bukkit.plugin.java.JavaPlugin:

Public Member Functions
	JavaPlugin ()

final File	getDataFolder ()
	Returns the folder that the plugin data's files are located in.

final PluginLoader	getPluginLoader ()
	Gets the associated PluginLoader responsible for this plugin.

final Server	getServer ()
	Returns the Server instance currently running this plugin.

final boolean	isEnabled ()
	Returns a value indicating whether or not this plugin is currently enabled.

final PluginDescriptionFile	getDescription ()
	Returns the plugin.yaml file containing the details for this plugin.

FileConfiguration	getConfig ()

void	reloadConfig ()

void	saveConfig ()

void	saveDefaultConfig ()

void	saveResource (String resourcePath, boolean replace)

InputStream	getResource (String filename)

List< Class<?> >	getDatabaseClasses ()
	Provides a list of all classes that should be persisted in the database.

final boolean	isInitialized ()
	Gets the initialization status of this plugin.

boolean	onCommand (CommandSender sender, Command command, String label, String[] args)


List< String >	onTabComplete (CommandSender sender, Command command, String alias, String[] args)


PluginCommand	getCommand (String name)
	Gets the command with the given name, specific to this plugin.

void	onLoad ()

void	onDisable ()

void	onEnable ()

ChunkGenerator	getDefaultWorldGenerator (String worldName, String id)

final boolean	isNaggable ()

final void	setNaggable (boolean canNag)

EbeanServer	getDatabase ()

final Logger	getLogger ()

String	toString ()

Public Member Functions inherited from org.bukkit.plugin.PluginBase
final int	hashCode ()

final boolean	equals (Object obj)

final String	getName ()

Public Member Functions inherited from org.bukkit.plugin.Plugin
File	getDataFolder ()
	Returns the folder that the plugin data's files are located in.

PluginDescriptionFile	getDescription ()
	Returns the plugin.yaml file containing the details for this plugin.

FileConfiguration	getConfig ()
	Gets a FileConfiguration for this plugin, read through "config.yml".

InputStream	getResource (String filename)
	Gets an embedded resource in this plugin.

void	saveConfig ()
	Saves the FileConfiguration retrievable by getConfig().

void	saveDefaultConfig ()
	Saves the raw contents of the default config.yml file to the location retrievable by getConfig().

void	saveResource (String resourcePath, boolean replace)
	Saves the raw contents of any resource embedded with a plugin's .jar file assuming it can be found using getResource(String).

void	reloadConfig ()
	Discards any data in getConfig() and reloads from disk.

PluginLoader	getPluginLoader ()
	Gets the associated PluginLoader responsible for this plugin.

Server	getServer ()
	Returns the Server instance currently running this plugin.

boolean	isEnabled ()
	Returns a value indicating whether or not this plugin is currently enabled.

void	onDisable ()
	Called when this plugin is disabled.

void	onLoad ()
	Called after a plugin is loaded but before it has been enabled.

void	onEnable ()
	Called when this plugin is enabled.

boolean	isNaggable ()
	Simple boolean if we can still nag to the logs about things.

void	setNaggable (boolean canNag)
	Set naggable state.

EbeanServer	getDatabase ()
	Gets the EbeanServer tied to this plugin.

ChunkGenerator	getDefaultWorldGenerator (String worldName, String id)
	Gets a ChunkGenerator for use in a default world, as specified in the server configuration.

Logger	getLogger ()
	Returns the primary logger associated with this server instance.

String	getName ()
	Returns the name of the plugin.

Protected Member Functions
File	getFile ()
	Returns the file which contains this plugin.

final ClassLoader	getClassLoader ()
	Returns the ClassLoader which holds this plugin.

final void	setEnabled (final boolean enabled)
	Sets the enabled state of this plugin.

final void	initialize (PluginLoader loader, Server server, PluginDescriptionFile description, File dataFolder, File file, ClassLoader classLoader)
	Initializes this plugin with the given variables.

void	installDDL ()

void	removeDDL ()

Detailed Description

Represents a Java plugin.

Definition at line 37 of file JavaPlugin.java.

Constructor & Destructor Documentation

org.bukkit.plugin.java.JavaPlugin.JavaPlugin ( )

Definition at line 52 of file JavaPlugin.java.

Member Function Documentation

final ClassLoader org.bukkit.plugin.java.JavaPlugin.getClassLoader ( )

protected

Returns the ClassLoader which holds this plugin.

Returns: ClassLoader holding this plugin

Definition at line 203 of file JavaPlugin.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.disablePlugin(), org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(), and org.bukkit.plugin.java.JavaPlugin.getResource().

PluginCommand org.bukkit.plugin.java.JavaPlugin.getCommand ( String name )

Gets the command with the given name, specific to this plugin.

Parameters

name	Name or alias of the command

Returns: PluginCommand if found, otherwise null

Definition at line 315 of file JavaPlugin.java.

References org.bukkit.plugin.PluginDescriptionFile.getName(), org.bukkit.command.PluginCommand.getPlugin(), org.bukkit.Server.getPluginCommand(), and org.bukkit.plugin.java.JavaPlugin.getServer().

FileConfiguration org.bukkit.plugin.java.JavaPlugin.getConfig ( )

Definition at line 109 of file JavaPlugin.java.

References org.bukkit.plugin.java.JavaPlugin.reloadConfig().

Referenced by org.bukkit.plugin.java.JavaPlugin.saveConfig().

EbeanServer org.bukkit.plugin.java.JavaPlugin.getDatabase ( )

Definition at line 349 of file JavaPlugin.java.

Referenced by org.bukkit.plugin.java.JavaPlugin.installDDL(), and org.bukkit.plugin.java.JavaPlugin.removeDDL().

List<Class<?> > org.bukkit.plugin.java.JavaPlugin.getDatabaseClasses ( )

Provides a list of all classes that should be persisted in the database.

Returns: List of Classes that are Ebeans

Definition at line 276 of file JavaPlugin.java.

Referenced by org.bukkit.plugin.java.JavaPlugin.initialize().

final File org.bukkit.plugin.java.JavaPlugin.getDataFolder ( )

Returns the folder that the plugin data's files are located in.

The folder may not yet exist.

Returns: The folder.

Definition at line 60 of file JavaPlugin.java.

ChunkGenerator org.bukkit.plugin.java.JavaPlugin.getDefaultWorldGenerator	(	String	worldName,
		String	id
	)

Definition at line 336 of file JavaPlugin.java.

References org.bukkit.plugin.PluginDescriptionFile.getFullName(), org.bukkit.Server.getLogger(), and org.bukkit.plugin.java.JavaPlugin.getServer().

final PluginDescriptionFile org.bukkit.plugin.java.JavaPlugin.getDescription ( )

Returns the plugin.yaml file containing the details for this plugin.

Returns: Contents of the plugin.yaml file

Definition at line 105 of file JavaPlugin.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.disablePlugin(), and org.bukkit.plugin.java.JavaPluginLoader.enablePlugin().

File org.bukkit.plugin.java.JavaPlugin.getFile ( )

protected

Returns the file which contains this plugin.

Returns: File containing this plugin

Definition at line 96 of file JavaPlugin.java.

final Logger org.bukkit.plugin.java.JavaPlugin.getLogger ( )

Definition at line 367 of file JavaPlugin.java.

final PluginLoader org.bukkit.plugin.java.JavaPlugin.getPluginLoader ( )

Gets the associated PluginLoader responsible for this plugin.

Returns: PluginLoader that controls this plugin

Definition at line 69 of file JavaPlugin.java.

InputStream org.bukkit.plugin.java.JavaPlugin.getResource ( String filename )

Definition at line 178 of file JavaPlugin.java.

References org.bukkit.plugin.java.JavaPlugin.getClassLoader().

Referenced by org.bukkit.plugin.java.JavaPlugin.reloadConfig(), and org.bukkit.plugin.java.JavaPlugin.saveResource().

final Server org.bukkit.plugin.java.JavaPlugin.getServer ( )

Returns the Server instance currently running this plugin.

Returns: Server running this plugin

Definition at line 78 of file JavaPlugin.java.

Referenced by org.bukkit.plugin.java.JavaPlugin.getCommand(), and org.bukkit.plugin.java.JavaPlugin.getDefaultWorldGenerator().

final void org.bukkit.plugin.java.JavaPlugin.initialize	(	PluginLoader	loader,
		Server	server,
		PluginDescriptionFile	description,
		File	dataFolder,
		File	file,
		ClassLoader	classLoader
	)

protected

Initializes this plugin with the given variables.

This method should never be called manually.

Parameters

loader	PluginLoader that is responsible for this plugin
server	Server instance that is running this plugin
description	PluginDescriptionFile containing metadata on this plugin
dataFolder	Folder containing the plugin's data
file	File containing this plugin
classLoader	ClassLoader which holds this plugin