Pulling all pending Bukkit-JavaDoc changes

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

View File

@@ -9,7 +9,8 @@ import org.bukkit.plugin.Plugin;
public interface Permissible extends ServerOperator {
/**
* Checks if this object contains an override for the specified permission, by fully qualified name
* Checks if this object contains an override for the specified
* permission, by fully qualified name
*
* @param name Name of the permission
* @return true if the permission is set, otherwise false
@@ -17,7 +18,8 @@ public interface Permissible extends ServerOperator {
public boolean isPermissionSet(String name);
/**
* Checks if this object contains an override for the specified {@link Permission}
* Checks if this object contains an override for the specified {@link
* Permission}
*
* @param perm Permission to check
* @return true if the permission is set, otherwise false
@@ -27,7 +29,8 @@ public interface Permissible extends ServerOperator {
/**
* Gets the value of the specified permission, if set.
* <p>
* If a permission override is not set on this object, the default value of the permission will be returned.
* If a permission override is not set on this object, the default value
* of the permission will be returned.
*
* @param name Name of the permission
* @return Value of the permission
@@ -37,7 +40,8 @@ public interface Permissible extends ServerOperator {
/**
* Gets the value of the specified permission, if set.
* <p>
* If a permission override is not set on this object, the default value of the permission will be returned
* If a permission override is not set on this object, the default value
* of the permission will be returned
*
* @param perm Permission to get
* @return Value of the permission
@@ -45,9 +49,11 @@ public interface Permissible extends ServerOperator {
public boolean hasPermission(Permission perm);
/**
* Adds a new {@link PermissionAttachment} with a single permission by name and value
* Adds a new {@link PermissionAttachment} with a single permission by
* name and value
*
* @param plugin Plugin responsible for this attachment, may not be null or disabled
* @param plugin Plugin responsible for this attachment, may not be null
* or disabled
* @param name Name of the permission to attach
* @param value Value of the permission
* @return The PermissionAttachment that was just created
@@ -57,27 +63,34 @@ public interface Permissible extends ServerOperator {
/**
* Adds a new empty {@link PermissionAttachment} to this object
*
* @param plugin Plugin responsible for this attachment, may not be null or disabled
* @param plugin Plugin responsible for this attachment, may not be null
* or disabled
* @return The PermissionAttachment that was just created
*/
public PermissionAttachment addAttachment(Plugin plugin);
/**
* Temporarily adds a new {@link PermissionAttachment} with a single permission by name and value
* Temporarily adds a new {@link PermissionAttachment} with a single
* permission by name and value
*
* @param plugin Plugin responsible for this attachment, may not be null or disabled
* @param plugin Plugin responsible for this attachment, may not be null
* or disabled
* @param name Name of the permission to attach
* @param value Value of the permission
* @param ticks Amount of ticks to automatically remove this attachment after
* @param ticks Amount of ticks to automatically remove this attachment
* after
* @return The PermissionAttachment that was just created
*/
public PermissionAttachment addAttachment(Plugin plugin, String name, boolean value, int ticks);
/**
* Temporarily adds a new empty {@link PermissionAttachment} to this object
* Temporarily adds a new empty {@link PermissionAttachment} to this
* object
*
* @param plugin Plugin responsible for this attachment, may not be null or disabled
* @param ticks Amount of ticks to automatically remove this attachment after
* @param plugin Plugin responsible for this attachment, may not be null
* or disabled
* @param ticks Amount of ticks to automatically remove this attachment
* after
* @return The PermissionAttachment that was just created
*/
public PermissionAttachment addAttachment(Plugin plugin, int ticks);
@@ -86,19 +99,22 @@ public interface Permissible extends ServerOperator {
* Removes the given {@link PermissionAttachment} from this object
*
* @param attachment Attachment to remove
* @throws IllegalArgumentException Thrown when the specified attachment isn't part of this object
* @throws IllegalArgumentException Thrown when the specified attachment
* isn't part of this object
*/
public void removeAttachment(PermissionAttachment attachment);
/**
* Recalculates the permissions for this object, if the attachments have changed values.
* Recalculates the permissions for this object, if the attachments have
* changed values.
* <p>
* This should very rarely need to be called from a plugin.
*/
public void recalculatePermissions();
/**
* Gets a set containing all of the permissions currently in effect by this object
* Gets a set containing all of the permissions currently in effect by
* this object
*
* @return Set of currently effective permissions
*/