Upstream/Essentials
1
0
Fork 0
mirror of https://github.com/EssentialsX/Essentials.git synced 2025-02-02 13:31:54 +01:00
Code Issues Projects Releases Wiki Activity

Fixed up javadoc comment errors

Browse Source
This commit is contained in:
ElgarL 2011-11-04 09:36:11 +00:00
parent 5560ab4294
commit 52c2110a2b
12 changed files with 137 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
EssentialsGroupManager/src/org/anjocaido/groupmanager/GlobalGroups.java
View File

@ -262,7 +262,7 @@ public class GlobalGroups {
/**
* Delete a group if it exist.
*
* @param newGroup
* @param groupName
*/
public boolean removeGroup(String groupName) {
// Push a new group
@ -278,7 +278,7 @@ public class GlobalGroups {
* Returns true if the Global Group exists in the globalgroups.yml
*
* @param groupName
* @return
* @return true if the group exists
*/
public boolean hasGroup(String groupName) {
return groups.containsKey(groupName.toLowerCase());
@ -289,7 +289,7 @@ public class GlobalGroups {
*
* @param groupName
* @param permissionNode
* @return
* @return true if node exists
*/
public boolean hasPermission(String groupName, String permissionNode) {
@ -306,7 +306,7 @@ public class GlobalGroups {
*
* @param groupName
* @param permissionNode
* @return
* @return PermissionCheckResult object
*/
public PermissionCheckResult checkPermission(String groupName, String permissionNode) {
@ -333,7 +333,7 @@ public class GlobalGroups {
* Returns a List of all permission nodes for this group null if none
*
* @param groupName
* @return
* @return List of all group names
*/
public List<String> getGroupsPermissions(String groupName) {
if (!hasGroup(groupName.toLowerCase()))
@ -345,7 +345,7 @@ public class GlobalGroups {
/**
* Returns a Set of all global group names.
*
* @return
* @return Set containing all group names.
*/
public Set<String> getGlobalGroups() {
return groups.keySet();
@ -363,7 +363,7 @@ public class GlobalGroups {
* Returns the Global Group or null if it doesn't exist.
*
* @param groupName
* @return
* @return Group object
*/
public Group getGroup(String groupName) {
if (!hasGroup(groupName.toLowerCase()))

2
EssentialsGroupManager/src/org/anjocaido/groupmanager/GroupManager.java
View File

@ -239,7 +239,7 @@ public class GroupManager extends JavaPlugin {
/**
* The handler in the interface created by AnjoCaido
*
* @return
* @return AnjoPermissionsHandler
*/
@Deprecated
public AnjoPermissionsHandler getPermissionHandler() {

2
EssentialsGroupManager/src/org/anjocaido/groupmanager/data/GroupVariables.java
View File

@ -46,7 +46,7 @@ public class GroupVariables extends Variables implements Cloneable {
/**
* A clone of all vars here.
* @return
* @return GroupVariables clone
*/
protected GroupVariables clone(Group newOwner) {
GroupVariables clone = new GroupVariables(newOwner);

2
EssentialsGroupManager/src/org/anjocaido/groupmanager/data/User.java
View File

@ -40,7 +40,7 @@ public class User extends DataUnit implements Cloneable {
/**
*
* @return
* @return User clone
*/
@Override
public User clone() {

2
EssentialsGroupManager/src/org/anjocaido/groupmanager/data/UserVariables.java
View File

@ -27,7 +27,7 @@ public class UserVariables extends Variables {
/**
* A clone of all vars here.
* @return
* @return UserVariables clone
*/
protected UserVariables clone(User newOwner) {
UserVariables clone = new UserVariables(newOwner);

2
EssentialsGroupManager/src/org/anjocaido/groupmanager/data/Variables.java
View File

@ -115,7 +115,7 @@ public abstract class Variables implements Cloneable {
/**
* All variable keys this is holding
* @return
* @return Set of all variable names.
*/
public Set<String> getVarKeyList() {
return variables.keySet();

11
EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/OverloadedWorldHolder.java
View File

@ -39,7 +39,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
/**
*
* @param userName
* @return
* @return user object or a new user if none exists.
*/
@Override
public User getUser(String userName) {
@ -86,7 +86,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
/**
*
* @param userName
* @return
* @return true if removed/false if not found.
*/
@Override
public boolean removeUser(String userName) {
@ -137,7 +137,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
/**
*
* @return
* @return Collection of all users
*/
@Override
public Collection<User> getUserList() {
@ -156,7 +156,7 @@ public class OverloadedWorldHolder extends WorldDataHolder {
/**
*
* @param userName
* @return
* @return true if user is overloaded.
*/
public boolean isOverloaded(String userName) {
return overloadedUsers.containsKey(userName.toLowerCase());
@ -189,8 +189,9 @@ public class OverloadedWorldHolder extends WorldDataHolder {
* Gets the user in normal state. Surpassing the overload state.
* It doesn't affect permissions. But it enables plugins change the
* actual user permissions even in overload mode.
*
* @param userName
* @return
* @return user object
*/
public User surpassOverload(String userName) {
if (!isOverloaded(userName)) {

22
EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/WorldDataHolder.java
View File

@ -163,7 +163,7 @@ public class WorldDataHolder {
/**
*
* @param userName
* @return
* @return true if we have data for this player.
*/
public boolean isUserDeclared(String userName) {
return users.containsKey(userName.toLowerCase());
@ -355,9 +355,11 @@ public class WorldDataHolder {
/**
* Returns a data holder for the given file
*
* @param worldName
* @param file
* @return
* @return a new WorldDataHolder
*
* @throws Exception
* @deprecated
*/
@ -506,7 +508,7 @@ public class WorldDataHolder {
* @param worldName
* @param groupsFile
* @param usersFile
* @return
*
* @throws FileNotFoundException
* @throws IOException
*/
@ -527,7 +529,7 @@ public class WorldDataHolder {
* @param ph
* @param groupsFile
* @param usersFile
* @return
*
* @throws FileNotFoundException
* @throws IOException
*/
@ -547,9 +549,9 @@ public class WorldDataHolder {
/**
* Updates the WorldDataHolder from the Groups file
*
* @param worldName
* @param ph
* @param groupsFile
* @return
*
* @throws FileNotFoundException
* @throws IOException
*/
@ -668,9 +670,9 @@ public class WorldDataHolder {
/**
* Updates the WorldDataHolder from the Users file
*
* @param worldName
* @param ph
* @param usersFile
* @return
*
* @throws FileNotFoundException
* @throws IOException
*/
@ -1030,7 +1032,7 @@ public class WorldDataHolder {
/**
*
* @return
* @return true if any user data has changed
*/
public boolean haveUsersChanged() {
if (haveUsersChanged) {
@ -1046,7 +1048,7 @@ public class WorldDataHolder {
/**
*
* @return
* @return true if any group data has changed.
*/
public boolean haveGroupsChanged() {
if (haveGroupsChanged) {

28
EssentialsGroupManager/src/org/anjocaido/groupmanager/dataholder/worlds/WorldsHolder.java
View File

@ -265,7 +265,7 @@ public class WorldsHolder {
* Mirrors prevails original data.
*
* @param worldName
* @return
* @return OverloadedWorldHolder
*/
public OverloadedWorldHolder getWorldData(String worldName) {
OverloadedWorldHolder data = worldsData.get(worldName.toLowerCase());
@ -295,31 +295,31 @@ public class WorldsHolder {
}
/**
* Retrieves the field p.getWorld().getName() and do
* Retrieves the field player.getWorld().getName() and do
* getWorld(worldName)
* @param p
* @return
* @param player
* @return OverloadedWorldHolder
*/
public OverloadedWorldHolder getWorldData(Player p) {
return getWorldData(p.getWorld().getName());
public OverloadedWorldHolder getWorldData(Player player) {
return getWorldData(player.getWorld().getName());
}
/**
* It does getWorld(worldName).getPermissionsHandler()
* @param worldName
* @return
* @return AnjoPermissionsHandler
*/
public AnjoPermissionsHandler getWorldPermissions(String worldName) {
return getWorldData(worldName).getPermissionsHandler();
}
/**
*It does getWorldData(p).getPermission
* @param p
* @return
* Returns the PermissionsHandler for this player data
* @param player
* @return AnjoPermissionsHandler
*/
public AnjoPermissionsHandler getWorldPermissions(Player p) {
return getWorldData(p).getPermissionsHandler();
public AnjoPermissionsHandler getWorldPermissions(Player player) {
return getWorldData(player).getPermissionsHandler();
}
/**
@ -408,7 +408,7 @@ public class WorldsHolder {
* Copies the specified world data to another world
* @param fromWorld
* @param toWorld
* @return
* @return true if successfully copied.
*/
public boolean cloneWorld(String fromWorld, String toWorld) {
File fromWorldFolder = new File(worldsFolder, fromWorld);
@ -514,7 +514,7 @@ public class WorldsHolder {
/**
* Returns all physically loaded worlds.
* @return
* @return ArrayList<OverloadedWorldHolder> of all loaded worlds
*/
public ArrayList<OverloadedWorldHolder> allWorldsDataList() {
ArrayList<OverloadedWorldHolder> list = new ArrayList<OverloadedWorldHolder>();

45
EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/AnjoPermissionsHandler.java
View File

@ -46,7 +46,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param player
* @param permission
* @return
* @return true if the player has the permission
*/
@Override
public boolean has(Player player, String permission) {
@ -58,7 +58,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param player
* @param permission
* @return
* @return true if the player has the permission
*/
@Override
public boolean permission(Player player, String permission) {
@ -70,7 +70,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param playerName
* @param permission
* @return
* @return true if the player has the permission
*/
public boolean permission(String playerName, String permission) {
return checkUserPermission(ph.getUser(playerName), permission);
@ -80,7 +80,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
* Returns the name of the group of that player name.
*
* @param userName
* @return
* @return String of players group name.
*/
@Override
public String getGroup(String userName) {
@ -92,7 +92,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
* player.
*
* @param userName
* @return
* @return List<String> of all players permissions.
*/
@Override
public List<String> getAllPlayersPermissions(String userName) {
@ -139,19 +139,19 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
}
/**
* Verify if player is in suck group. It will check it's groups inheritance.
* Verify if player is in such group. It will check it's groups inheritance.
*
* So if you have a group Admin > Moderator
*
* And verify the player 'MyAdmin', which is Admin, it will return true for
* both Admin or Moderator groups.
*
* Mas if you have a player 'MyModerator', which is Moderator, it will give
* If you have a player 'MyModerator', which is Moderator, it will give
* false if you pass Admin in group parameter.
*
* @param name
* @param group
* @return
* @return true if in group (with inheritance)
*/
@Override
public boolean inGroup(String name, String group) {
@ -227,11 +227,8 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
/**
* Check if user can build. Checks inheritance and subgroups.
*
* @param world
* Player's world
* @param user
* Player's name
* @return Whether the user can build
* @param userName Player's name
* @return true if the user can build
*/
public boolean canUserBuild(String userName) {
@ -258,7 +255,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
* Return the suffix for the given group name
*
* @param groupName
* @return
* @return empty string if not found.
*/
@Override
public String getGroupSuffix(String groupName) {
@ -270,9 +267,11 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
}
/**
* Checks the specified group for the Info Build node.
* Does NOT check inheritance
*
* @param groupName
* @return
* @return true if can build
*/
@Override
public boolean canGroupBuild(String groupName) {
@ -372,7 +371,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param user
* @param variable
* @return
* @return empty string if not found
*/
@Override
public String getUserPermissionString(String user, String variable) {
@ -388,7 +387,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param user
* @param variable
* @return
* @return -1 if not found
*/
@Override
public int getUserPermissionInteger(String user, String variable) {
@ -404,7 +403,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param user
* @param variable
* @return
* @return boolean value
*/
@Override
public boolean getUserPermissionBoolean(String user, String variable) {
@ -420,7 +419,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param user
* @param variable
* @return
* @return -1 if not found
*/
@Override
public double getUserPermissionDouble(String user, String variable) {
@ -592,7 +591,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param user
* @param permission
* @return
* @return PermissionCheckResult
*/
public PermissionCheckResult checkUserOnlyPermission(User user, String permission) {
user.sortPermissions();
@ -670,7 +669,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param user
* @param targetPermission
* @return
* @return PermissionCheckResult
*/
public PermissionCheckResult checkFullUserPermission(User user, String targetPermission) {
PermissionCheckResult result = new PermissionCheckResult();
@ -851,7 +850,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
*
* @param start
* @param targetPermission
* @return
* @return PermissionCheckResult
*/
public PermissionCheckResult checkGroupPermissionWithInheritance(Group start, String targetPermission) {
if (start == null || targetPermission == null) {
@ -1016,7 +1015,7 @@ public class AnjoPermissionsHandler extends PermissionsReaderInterface {
* Including subgroups.
*
* @param userName
* @return
* @return String[] of all group names.
*/
@Override
public String[] getGroups(String userName) {

2
EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/BukkitPermissions.java
View File

@ -187,7 +187,7 @@ public class BukkitPermissions {
* null is empty
*
* @param node
* @return
* @return Map of child permissions
*/
public Map<String, Boolean> getChildren(String node) {
for (Permission permission : registeredPermissions) {

139
EssentialsGroupManager/src/org/anjocaido/groupmanager/permissions/PermissionsReaderInterface.java
View File

@ -16,6 +16,7 @@ import org.bukkit.entity.Player;
*
* @author Nijikokun
* @author Gabriel Couto
* @author ElgarL
*/
public abstract class PermissionsReaderInterface {
@ -23,7 +24,7 @@ public abstract class PermissionsReaderInterface {
*
* @param player
* @param string
* @return
* @return true if has permission
*/
public abstract boolean has(Player player, String string);
@ -31,141 +32,141 @@ public abstract class PermissionsReaderInterface {
*
* @param player
* @param string
* @return
* @return true if has permission
*/
public abstract boolean permission(Player player, String string);
/**
*
* @param string
* @return
* @param userName
* @return group name for this player.
*/
public abstract String getGroup(String string);
public abstract String getGroup(String userName);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param groupName
* @return true if in group
*/
public abstract boolean inGroup(String string, String string1);
public abstract boolean inGroup(String userName, String groupName);
/**
*
* @param string
* @return
* @param groupName
* @return String of prefix
*/
public abstract String getGroupPrefix(String string);
public abstract String getGroupPrefix(String groupName);
/**
*
* @param string
* @return
* @param groupName
* @return String of suffix
*/
public abstract String getGroupSuffix(String string);
public abstract String getGroupSuffix(String groupName);
/**
*
* @param string
* @return
* @param groupName
* @return true if can build
*/
public abstract boolean canGroupBuild(String string);
public abstract boolean canGroupBuild(String groupName);
/**
*
* @param string
* @param string1
* @return
* @param groupName
* @param node
* @return String value
*/
public abstract String getGroupPermissionString(String string, String string1);
public abstract String getGroupPermissionString(String groupName, String node);
/**
*
* @param string
* @param string1
* @return
* @param groupName
* @param node
* @return integer value
*/
public abstract int getGroupPermissionInteger(String string, String string1);
public abstract int getGroupPermissionInteger(String groupName, String node);
/**
*
* @param string
* @param string1
* @return
* @param groupName
* @param node
* @return boolean value
*/
public abstract boolean getGroupPermissionBoolean(String string, String string1);
public abstract boolean getGroupPermissionBoolean(String groupName, String node);
/**
*
* @param string
* @param string1
* @return
* @param groupName
* @param node
* @return double value
*/
public abstract double getGroupPermissionDouble(String string, String string1);
public abstract double getGroupPermissionDouble(String groupName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return String value
*/
public abstract String getUserPermissionString(String string, String string1);
public abstract String getUserPermissionString(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return integer value
*/
public abstract int getUserPermissionInteger(String string, String string1);
public abstract int getUserPermissionInteger(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return boolean value
*/
public abstract boolean getUserPermissionBoolean(String string, String string1);
public abstract boolean getUserPermissionBoolean(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return double value
*/
public abstract double getUserPermissionDouble(String string, String string1);
public abstract double getUserPermissionDouble(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return String value
*/
public abstract String getPermissionString(String string, String string1);
public abstract String getPermissionString(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return integer value
*/
public abstract int getPermissionInteger(String string, String string1);
public abstract int getPermissionInteger(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return boolean value
*/
public abstract boolean getPermissionBoolean(String string, String string1);
public abstract boolean getPermissionBoolean(String userName, String node);
/**
*
* @param string
* @param string1
* @return
* @param userName
* @param node
* @return double value
*/
public abstract double getPermissionDouble(String string, String string1);
public abstract double getPermissionDouble(String userName, String node);
/////////////////////////////
/**
@ -173,7 +174,7 @@ public abstract class PermissionsReaderInterface {
* This method is a utility method for chat plugins to get the user's prefix
* without having to look at every one of the user's ancestors.
* Returns an empty string if user has no parent groups.
* @param world Player's world
*
* @param user Player's name
* @return Player's prefix
*/
@ -184,7 +185,7 @@ public abstract class PermissionsReaderInterface {
* This method is a utility method for chat plugins to get the user's suffix
* without having to look at every one of the user's ancestors.
* Returns an empty string if user has no parent groups.
* @param world Player's world
*
* @param user Player's name
* @return Player's suffix
*/
@ -215,7 +216,7 @@ public abstract class PermissionsReaderInterface {
* @param entryName
* @param path
* @param isGroup
* @return
* @return -1 if not found
*/
public abstract double getInfoDouble(String entryName, String path, boolean isGroup);
//public abstract double getInfoDouble(String entryName, String path, boolean isGroup, Comparator<Double> comparator);