mirror of
https://github.com/PaperMC/Paper.git
synced 2025-08-11 18:22:08 -07:00
Pulling all pending Bukkit-JavaDoc changes
By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -169,11 +169,11 @@ public interface Plugin extends TabExecutor {
|
||||
public ChunkGenerator getDefaultWorldGenerator(String worldName, String id);
|
||||
|
||||
/**
|
||||
* Returns the primary logger associated with this server instance. The
|
||||
* Returns the plugin logger associated with this server's logger. The
|
||||
* returned logger automatically tags all log messages with the plugin's
|
||||
* name.
|
||||
*
|
||||
* @return Logger associated with this server
|
||||
* @return Logger associated with this plugin
|
||||
*/
|
||||
public Logger getLogger();
|
||||
|
||||
|
@@ -617,6 +617,7 @@ public final class PluginDescriptionFile {
|
||||
* # Having an empty declaration is useful for defining the description, permission, and messages from a configuration dynamically
|
||||
* apocalypse:
|
||||
*</pre></blockquote>
|
||||
* Note: command names may not have a colon in their name.
|
||||
*
|
||||
* @return the commands this plugin will register
|
||||
*/
|
||||
|
@@ -417,14 +417,15 @@ public abstract class JavaPlugin extends PluginBase {
|
||||
* resided in a different jar / classloader.
|
||||
*
|
||||
* @param clazz the class desired
|
||||
* @return the plugin that provides and implements said class, or null
|
||||
* if called from an inconsistent static initialization block
|
||||
* @return the plugin that provides and implements said class
|
||||
* @throws IllegalArgumentException if clazz is null
|
||||
* @throws IllegalArgumentException if clazz does not extend {@link
|
||||
* JavaPlugin}
|
||||
* @throws IllegalArgumentException if clazz was not provided by a
|
||||
* plugin, for example, if called with
|
||||
* @throws IllegalStateException if clazz was not provided by a plugin,
|
||||
* for example, if called with
|
||||
* <code>JavaPlugin.getPlugin(JavaPlugin.class)</code>
|
||||
* @throws IllegalStateException if called from the static initializer for
|
||||
* given JavaPlugin
|
||||
* @throws ClassCastException if plugin that provided the class does not
|
||||
* extend the class
|
||||
*/
|
||||
@@ -445,9 +446,14 @@ public abstract class JavaPlugin extends PluginBase {
|
||||
}
|
||||
|
||||
/**
|
||||
* This method provides fast access to the plugin that has {@link
|
||||
* #getProvidingPlugin(Class) provided} the given plugin class, which is
|
||||
* usually the plugin that implemented it.
|
||||
* This method provides fast access to the plugin that has provided the
|
||||
* given class.
|
||||
*
|
||||
* @throws IllegalArgumentException if the class is not provided by a
|
||||
* JavaPlugin
|
||||
* @throws IllegalArgumentException if class is null
|
||||
* @throws IllegalStateException if called from the static initializer for
|
||||
* given JavaPlugin
|
||||
*/
|
||||
public static JavaPlugin getProvidingPlugin(Class<?> clazz) {
|
||||
Validate.notNull(clazz, "Null class cannot have a plugin");
|
||||
|
Reference in New Issue
Block a user