Added JavaDocs to AdminPermission class

This commit is contained in:
Tim Visée 2015-12-01 16:29:47 +01:00
parent 4afef9714d
commit 42cebacd60

View File

@ -5,49 +5,115 @@ package fr.xephi.authme.permission;
*/ */
public enum AdminPermission implements PermissionNode { public enum AdminPermission implements PermissionNode {
/**
* Administrator command to register a new user.
*/
REGISTER("authme.command.admin.register"), REGISTER("authme.command.admin.register"),
/**
* Administrator command to unregister an existing user.
*/
UNREGISTER("authme.command.admin.unregister"), UNREGISTER("authme.command.admin.unregister"),
/**
* Administrator command to force-login an existing user.
*/
FORCE_LOGIN("authme.command.admin.forcelogin"), FORCE_LOGIN("authme.command.admin.forcelogin"),
/**
* Administrator command to change the password of a user.
*/
CHANGE_PASSWORD("authme.command.admin.changepassword"), CHANGE_PASSWORD("authme.command.admin.changepassword"),
/**
* Administrator command to see the last login date and time of an user.
*/
LAST_LOGIN("authme.command.admin.lastlogin"), LAST_LOGIN("authme.command.admin.lastlogin"),
/**
* Administrator command to see all accounts associated with an user.
*/
ACCOUNTS("authme.command.admin.accounts"), ACCOUNTS("authme.command.admin.accounts"),
/**
* Administrator command to get the email address of an user, if set.
*/
GET_EMAIL("authme.command.admin.getemail"), GET_EMAIL("authme.command.admin.getemail"),
/**
* Administrator command to set or change the email adress of an user.
*/
CHANGE_EMAIL("authme.command.admin.changemail"), CHANGE_EMAIL("authme.command.admin.changemail"),
/**
* Administrator command to get the last known IP of an user.
*/
GET_IP("authme.command.admin.getip"), GET_IP("authme.command.admin.getip"),
/**
* Administrator command to teleport to the AuthMe spawn.
*/
SPAWN("authme.command.admin.spawn"), SPAWN("authme.command.admin.spawn"),
/**
* Administrator command to set the AuthMe spawn.
*/
SET_SPAWN("authme.command.admin.setspawn"), SET_SPAWN("authme.command.admin.setspawn"),
/**
* Administrator command to teleport to the first AuthMe spawn.
*/
FIRST_SPAWN("authme.command.admin.firstspawn"), FIRST_SPAWN("authme.command.admin.firstspawn"),
/**
* Administrator command to set the first AuthMe spawn.
*/
SET_FIRST_SPAWN("authme.command.admin.setfirstspawn"), SET_FIRST_SPAWN("authme.command.admin.setfirstspawn"),
/**
* Administrator command to purge old user data.
*/
PURGE("authme.command.admin.purge"), PURGE("authme.command.admin.purge"),
/**
* Administrator command to purge the last position of an user.
*/
PURGE_LAST_POSITION("authme.command.admin.purgelastpos"), PURGE_LAST_POSITION("authme.command.admin.purgelastpos"),
/**
* Administrator command to purge all data associated with banned players.
*/
PURGE_BANNED_PLAYERS("authme.command.admin.purgebannedplayers"), PURGE_BANNED_PLAYERS("authme.command.admin.purgebannedplayers"),
/**
* Administrator command to toggle the AntiBot protection status.
*/
SWITCH_ANTIBOT("authme.command.admin.switchantibot"), SWITCH_ANTIBOT("authme.command.admin.switchantibot"),
/**
* Administrator command to reload the plugin configuration.
*/
RELOAD("authme.command.admin.reload"); RELOAD("authme.command.admin.reload");
/**
* Permission node.
*/
private String node; private String node;
/**
* Get the permission node.
* @return
*/
@Override @Override
public String getNode() { public String getNode() {
return node; return node;
} }
/**
* Constructor.
*
* @param node Permission node.
*/
AdminPermission(String node) { AdminPermission(String node) {
this.node = node; this.node = node;
} }