org.bukkit.plugin.PluginDescriptionFile Class Reference

Provides access to a Plugins description file, plugin.yaml. More...

Public Member Functions
	PluginDescriptionFile (final InputStream stream) throws InvalidDescriptionException
	PluginDescriptionFile (final Reader reader) throws InvalidDescriptionException
	Loads a PluginDescriptionFile from the specified reader.
	PluginDescriptionFile (final String pluginName, final String pluginVersion, final String mainClass)
	Creates a new PluginDescriptionFile with the given detailed.
void	save (Writer writer)
	Saves this PluginDescriptionFile to the given writer.
String	getName ()
	Returns the name of a plugin.
String	getVersion ()
	Returns the version of a plugin.
String	getFullName ()
	Returns the name of a plugin including the version.
String	getMain ()
	Returns the main class for a plugin.
Map< String, Map< String, Object > >	getCommands ()
List< String >	getDepend ()
List< String >	getSoftDepend ()
List< String >	getLoadBefore ()
	Gets the list of plugins that should consider this plugin a soft-dependency.
PluginLoadOrder	getLoad ()
String	getDescription ()
	Gets the description of this plugin.
List< String >	getAuthors ()
String	getWebsite ()
boolean	isDatabaseEnabled ()
void	setDatabaseEnabled (boolean database)
List< Permission >	getPermissions ()
PermissionDefault	getPermissionDefault ()
String	getClassLoaderOf ()
String	getPrefix ()

Detailed Description

Provides access to a Plugins description file, plugin.yaml.

Definition at line 21 of file PluginDescriptionFile.java.

Constructor & Destructor Documentation

org.bukkit.plugin.PluginDescriptionFile.PluginDescriptionFile

(

final InputStream

stream

)

throws InvalidDescriptionException

Definition at line 41 of file PluginDescriptionFile.java.

org.bukkit.plugin.PluginDescriptionFile.PluginDescriptionFile

(

final Reader

reader

)

throws InvalidDescriptionException

Loads a PluginDescriptionFile from the specified reader.

Parameters

reader

The reader

Exceptions

InvalidDescriptionException

If the PluginDescriptionFile is invalid

Definition at line 51 of file PluginDescriptionFile.java.

org.bukkit.plugin.PluginDescriptionFile.PluginDescriptionFile	(	final String	pluginName,
		final String	pluginVersion,
		final String	mainClass
	)

Creates a new PluginDescriptionFile with the given detailed.

Parameters

pluginName	Name of this plugin
pluginVersion	Version of this plugin
mainClass	Full location of the main class of this plugin

Definition at line 62 of file PluginDescriptionFile.java.

Member Function Documentation

List<String> org.bukkit.plugin.PluginDescriptionFile.getAuthors

(

)

Definition at line 146 of file PluginDescriptionFile.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.createRegisteredListeners().

String org.bukkit.plugin.PluginDescriptionFile.getClassLoaderOf

(

)

Definition at line 178 of file PluginDescriptionFile.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.loadPlugin().

Map<String, Map<String, Object> > org.bukkit.plugin.PluginDescriptionFile.getCommands

(

)

Definition at line 113 of file PluginDescriptionFile.java.

Referenced by org.bukkit.command.PluginCommandYamlParser.parse().

List<String> org.bukkit.plugin.PluginDescriptionFile.getDepend

(

)

Definition at line 117 of file PluginDescriptionFile.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(), and org.bukkit.plugin.SimplePluginManager.loadPlugins().

String org.bukkit.plugin.PluginDescriptionFile.getDescription

(

)

Gets the description of this plugin.

Returns

Description of this plugin

Definition at line 142 of file PluginDescriptionFile.java.

String org.bukkit.plugin.PluginDescriptionFile.getFullName

(

)

Returns the name of a plugin including the version.

Returns

String name

Definition at line 100 of file PluginDescriptionFile.java.

Referenced by org.bukkit.permissions.PermissibleBase.addAttachment(), org.bukkit.plugin.java.JavaPluginLoader.createRegisteredListeners(), org.bukkit.plugin.SimplePluginManager.disablePlugin(), org.bukkit.plugin.java.JavaPluginLoader.disablePlugin(), org.bukkit.plugin.SimplePluginManager.enablePlugin(), org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(), org.bukkit.command.PluginCommand.execute(), org.bukkit.plugin.java.JavaPlugin.getDefaultWorldGenerator(), org.bukkit.WorldCreator.getGeneratorForName(), org.bukkit.plugin.PluginDescriptionFile.getPermissions(), org.bukkit.permissions.PermissionAttachment.PermissionAttachment(), org.bukkit.command.PluginCommand.tabComplete(), org.bukkit.command.PluginCommand.toString(), and org.bukkit.plugin.java.JavaPlugin.toString().

PluginLoadOrder org.bukkit.plugin.PluginDescriptionFile.getLoad

(

)

Definition at line 133 of file PluginDescriptionFile.java.

List<String> org.bukkit.plugin.PluginDescriptionFile.getLoadBefore

(

)

Gets the list of plugins that should consider this plugin a soft-dependency.

Returns

immutable list of plugins that should consider this plugin a soft-dependency

Definition at line 129 of file PluginDescriptionFile.java.

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

String org.bukkit.plugin.PluginDescriptionFile.getMain

(

)

Returns the main class for a plugin.

Returns

Java classpath

Definition at line 109 of file PluginDescriptionFile.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.loadPlugin().

String org.bukkit.plugin.PluginDescriptionFile.getName

(

)

Returns the name of a plugin.

Returns

String name

Definition at line 82 of file PluginDescriptionFile.java.

Referenced by org.bukkit.plugin.java.JavaPluginLoader.disablePlugin(), org.bukkit.plugin.SimplePluginManager.enablePlugin(), org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(), org.bukkit.plugin.java.JavaPlugin.getCommand(), org.bukkit.plugin.PluginBase.getName(), org.bukkit.plugin.java.JavaPlugin.initialize(), org.bukkit.plugin.java.JavaPluginLoader.loadPlugin(), org.bukkit.plugin.SimplePluginManager.loadPlugin(), org.bukkit.plugin.SimplePluginManager.loadPlugins(), org.bukkit.plugin.PluginLogger.PluginLogger(), and org.bukkit.conversations.PluginNameConversationPrefix.PluginNameConversationPrefix().

PermissionDefault org.bukkit.plugin.PluginDescriptionFile.getPermissionDefault

(

)

Definition at line 174 of file PluginDescriptionFile.java.

List<Permission> org.bukkit.plugin.PluginDescriptionFile.getPermissions

(

)

Definition at line 162 of file PluginDescriptionFile.java.

References org.bukkit.plugin.PluginDescriptionFile.getFullName(), and org.bukkit.permissions.Permission.loadPermissions().

String org.bukkit.plugin.PluginDescriptionFile.getPrefix

(

)

Definition at line 182 of file PluginDescriptionFile.java.

Referenced by org.bukkit.plugin.PluginLogger.PluginLogger().

List<String> org.bukkit.plugin.PluginDescriptionFile.getSoftDepend

(

)

Definition at line 121 of file PluginDescriptionFile.java.

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

String org.bukkit.plugin.PluginDescriptionFile.getVersion

(

)

Returns the version of a plugin.

Returns

String name

Definition at line 91 of file PluginDescriptionFile.java.

String org.bukkit.plugin.PluginDescriptionFile.getWebsite

(

)

Definition at line 150 of file PluginDescriptionFile.java.

boolean org.bukkit.plugin.PluginDescriptionFile.isDatabaseEnabled

(

)

Definition at line 154 of file PluginDescriptionFile.java.

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

void org.bukkit.plugin.PluginDescriptionFile.save

(

Writer

writer

)

Saves this PluginDescriptionFile to the given writer.

Parameters

writer

Writer to output this file to

Definition at line 73 of file PluginDescriptionFile.java.

void org.bukkit.plugin.PluginDescriptionFile.setDatabaseEnabled

(

boolean

database

)

Definition at line 158 of file PluginDescriptionFile.java.

---

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

• org/bukkit/plugin/PluginDescriptionFile.java