Generic cleaning

By: Erik Broes <erikbroes@grum.nl>
This commit is contained in:
Bukkit/Spigot
2012-01-15 14:37:30 +01:00
parent 8377ee22f8
commit 4c80a49933
61 changed files with 245 additions and 272 deletions

View File

@@ -25,7 +25,7 @@ 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.
*
* @param name Name of the permission
@@ -35,7 +35,7 @@ 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
*
* @param perm Permission to get
@@ -91,7 +91,7 @@ public interface Permissible extends ServerOperator {
/**
* 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();

View File

@@ -91,7 +91,7 @@ public class Permission {
/**
* Sets the default value of this permission.
*
* <p />
* This will not be saved to disk, and is a temporary operation until the server reloads permissions.
* Changing this default will cause all {@link Permissible}s that contain this permission to recalculate their permissions
*
@@ -117,7 +117,7 @@ public class Permission {
/**
* Sets the description of this permission.
*
* <p />
* This will not be saved to disk, and is a temporary operation until the server reloads permissions.
*
* @param value The new description to set
@@ -132,7 +132,7 @@ public class Permission {
/**
* Gets a set containing every {@link Permissible} that has this permission.
*
* <p />
* This set cannot be modified.
*
* @return Set containing permissibles with this permission
@@ -143,7 +143,7 @@ public class Permission {
/**
* Recalculates all {@link Permissible}s that contain this permission.
*
* <p />
* This should be called after modifying the children, and is automatically called after modifying the default value
*/
public void recalculatePermissibles() {
@@ -158,7 +158,7 @@ public class Permission {
/**
* Adds this permission to the specified parent permission.
*
* <p />
* If the parent permission does not exist, it will be created and registered.
*
* @param name Name of the parent permission
@@ -194,7 +194,7 @@ public class Permission {
/**
* Loads a list of Permissions from a map of data, usually used from retrieval from a yaml file.
*
* <p />
* The data may contain a list of name:data, where the data contains the following keys:
* default: Boolean true or false. If not specified, false.
* children: Map<String, Boolean> of child permissions. If not specified, empty list.
@@ -220,7 +220,7 @@ public class Permission {
/**
* Loads a Permission from a map of data, usually used from retrieval from a yaml file.
*
* <p />
* The data may contain the following keys:
* default: Boolean true or false. If not specified, false.
* children: Map<String, Boolean> of child permissions. If not specified, empty list.
@@ -236,7 +236,7 @@ public class Permission {
/**
* Loads a Permission from a map of data, usually used from retrieval from a yaml file.
*
* <p />
* The data may contain the following keys:
* default: Boolean true or false. If not specified, false.
* children: Map<String, Boolean> of child permissions. If not specified, empty list.

View File

@@ -62,7 +62,7 @@ public class PermissionAttachment {
/**
* Gets a copy of all set permissions and values contained within this attachment.
*
* <p />
* This map may be modified but will not affect the attachment, as it is a copy.
*
* @return Copy of all permissions and values expressed by this attachment
@@ -95,7 +95,7 @@ public class PermissionAttachment {
/**
* Removes the specified permission from this attachment.
*
* <p />
* If the permission does not exist in this attachment, nothing will happen.
*
* @param name Name of the permission to remove
@@ -107,7 +107,7 @@ public class PermissionAttachment {
/**
* Removes the specified permission from this attachment.
*
* <p />
* If the permission does not exist in this attachment, nothing will happen.
*
* @param perm Permission to remove