SteamWar/Paper
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pulling all pending Bukkit-JavaDoc changes

Browse Source 
A special thanks goes to @aerouk for almost all of the changes found here.

By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
Bukkit/Spigot
2013-12-15 01:07:43 -05:00
parent 800679913f
commit bb50f1a774
310 changed files with 4218 additions and 2904 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
paper-api/src/main/java/org/bukkit/plugin/PluginManager.java
View File

@@ -18,7 +18,8 @@ public interface PluginManager {
* Registers the specified plugin loader
*
* @param loader Class name of the PluginLoader to register
* @throws IllegalArgumentException Thrown when the given Class is not a valid PluginLoader
* @throws IllegalArgumentException Thrown when the given Class is not a
* valid PluginLoader
*/
public void registerInterface(Class<? extends PluginLoader> loader) throws IllegalArgumentException;
@@ -64,9 +65,12 @@ public interface PluginManager {
*
* @param file File containing the plugin to load
* @return The Plugin loaded, or null if it was invalid
* @throws InvalidPluginException Thrown when the specified file is not a valid plugin
* @throws InvalidDescriptionException Thrown when the specified file contains an invalid description
* @throws UnknownDependencyException If a required dependency could not be resolved
* @throws InvalidPluginException Thrown when the specified file is not a
* valid plugin
* @throws InvalidDescriptionException Thrown when the specified file
* contains an invalid description
* @throws UnknownDependencyException If a required dependency could not
* be resolved
*/
public Plugin loadPlugin(File file) throws InvalidPluginException, InvalidDescriptionException, UnknownDependencyException;
@@ -92,9 +96,11 @@ public interface PluginManager {
* Calls an event with the given details
*
* @param event Event details
* @throws IllegalStateException Thrown when an asynchronous event is fired from synchronous code.<br>
* <i>Note: This is best-effort basis, and should not be used to test synchronized state. This
* is an indicator for flawed flow logic.</i>
* @throws IllegalStateException Thrown when an asynchronous event is
* fired from synchronous code.
* <p>
* <i>Note: This is best-effort basis, and should not be used to test
* synchronized state. This is an indicator for flawed flow logic.</i>
*/
public void callEvent(Event event) throws IllegalStateException;
@@ -132,7 +138,8 @@ public interface PluginManager {
/**
* Enables the specified plugin
* <p>
* Attempting to enable a plugin that is already enabled will have no effect
* Attempting to enable a plugin that is already enabled will have no
* effect
*
* @param plugin Plugin to enable
*/
@@ -158,20 +165,23 @@ public interface PluginManager {
/**
* Adds a {@link Permission} to this plugin manager.
* <p>
* If a permission is already defined with the given name of the new permission,
* an exception will be thrown.
* If a permission is already defined with the given name of the new
* permission, an exception will be thrown.
*
* @param perm Permission to add
* @throws IllegalArgumentException Thrown when a permission with the same name already exists
* @throws IllegalArgumentException Thrown when a permission with the same
* name already exists
*/
public void addPermission(Permission perm);
/**
* Removes a {@link Permission} registration from this plugin manager.
* <p>
* If the specified permission does not exist in this plugin manager, nothing will happen.
* If the specified permission does not exist in this plugin manager,
* nothing will happen.
* <p>
* Removing a permission registration will <b>not</b> remove the permission from any {@link Permissible}s that have it.
* Removing a permission registration will <b>not</b> remove the
* permission from any {@link Permissible}s that have it.
*
* @param perm Permission to remove
*/
@@ -180,9 +190,11 @@ public interface PluginManager {
/**
* Removes a {@link Permission} registration from this plugin manager.
* <p>
* If the specified permission does not exist in this plugin manager, nothing will happen.
* If the specified permission does not exist in this plugin manager,
* nothing will happen.
* <p>
* Removing a permission registration will <b>not</b> remove the permission from any {@link Permissible}s that have it.
* Removing a permission registration will <b>not</b> remove the
* permission from any {@link Permissible}s that have it.
*
* @param name Permission to remove
*/
@@ -199,16 +211,19 @@ public interface PluginManager {
/**
* Recalculates the defaults for the given {@link Permission}.
* <p>
* This will have no effect if the specified permission is not registered here.
* This will have no effect if the specified permission is not registered
* here.
*
* @param perm Permission to recalculate
*/
public void recalculatePermissionDefaults(Permission perm);
/**
* Subscribes the given Permissible for information about the requested Permission, by name.
* Subscribes the given Permissible for information about the requested
* Permission, by name.
* <p>
* If the specified Permission changes in any form, the Permissible will be asked to recalculate.
* If the specified Permission changes in any form, the Permissible will
* be asked to recalculate.
*
* @param permission Permission to subscribe to
* @param permissible Permissible subscribing
@@ -216,7 +231,8 @@ public interface PluginManager {
public void subscribeToPermission(String permission, Permissible permissible);
/**
* Unsubscribes the given Permissible for information about the requested Permission, by name.
* Unsubscribes the given Permissible for information about the requested
* Permission, by name.
*
* @param permission Permission to unsubscribe from
* @param permissible Permissible subscribing
@@ -224,7 +240,8 @@ public interface PluginManager {
public void unsubscribeFromPermission(String permission, Permissible permissible);
/**
* Gets a set containing all subscribed {@link Permissible}s to the given permission, by name
* Gets a set containing all subscribed {@link Permissible}s to the given
* permission, by name
*
* @param permission Permission to query for
* @return Set containing all subscribed permissions
@@ -234,7 +251,8 @@ public interface PluginManager {
/**
* Subscribes to the given Default permissions by operator status
* <p>
* If the specified defaults change in any form, the Permissible will be asked to recalculate.
* If the specified defaults change in any form, the Permissible will be
* asked to recalculate.
*
* @param op Default list to subscribe to
* @param permissible Permissible subscribing
@@ -250,7 +268,8 @@ public interface PluginManager {
public void unsubscribeFromDefaultPerms(boolean op, Permissible permissible);
/**
* Gets a set containing all subscribed {@link Permissible}s to the given default list, by op status
* Gets a set containing all subscribed {@link Permissible}s to the given
* default list, by op status
*
* @param op Default list to query for
* @return Set containing all subscribed permissions