Create tool task that adds javadoc to the MessageKey entries

src/main/java/fr/xephi/authme/message/MessageKey.java

@@ -5,158 +5,235 @@ package fr.xephi.authme.message;
  */
 public enum MessageKey {
 
+    /** In order to use this command you must be authenticated! */
     DENIED_COMMAND("denied_command"),
 
+    /** A player with the same IP is already in game! */
     SAME_IP_ONLINE("same_ip_online"),
 
+    /** In order to chat you must be authenticated! */
     DENIED_CHAT("denied_chat"),
 
+    /** AntiBot protection mode is enabled! You have to wait some minutes before joining the server. */
     KICK_ANTIBOT("kick_antibot"),
 
+    /** Can't find the requested user in the database! */
     UNKNOWN_USER("unknown_user"),
 
+    /** Your quit location was unsafe, you have been teleported to the world's spawnpoint. */
     UNSAFE_QUIT_LOCATION("unsafe_spawn"),
 
+    /** You're not logged in! */
     NOT_LOGGED_IN("not_logged_in"),
 
+    /** You can register yourself to the server with the command "/register >password> >ConfirmPassword>" */
     REGISTER_VOLUNTARILY("reg_voluntarily"),
 
+    /** Usage: /login >password> */
     USAGE_LOGIN("usage_log"),
 
+    /** Wrong password! */
     WRONG_PASSWORD("wrong_pwd"),
 
+    /** Successfully unregistered! */
     UNREGISTERED_SUCCESS("unregistered"),
 
+    /** In-game registration is disabled! */
     REGISTRATION_DISABLED("reg_disabled"),
 
+    /** Logged-in due to Session Reconnection. */
     SESSION_RECONNECTION("valid_session"),
 
+    /** Successful login! */
     LOGIN_SUCCESS("login"),
 
+    /** Your account isn't activated yet, please check your emails! */
     ACCOUNT_NOT_ACTIVATED("vb_nonActiv"),
 
+    /** You already have registered this username! */
     NAME_ALREADY_REGISTERED("user_regged"),
 
+    /** You don't have the permission to perform this action! */
     NO_PERMISSION("no_perm"),
 
+    /** An unexpected error occurred, please contact an administrator! */
     ERROR("error"),
 
+    /** Please, login with the command "/login >password>" */
     LOGIN_MESSAGE("login_msg"),
 
+    /** Please, register to the server with the command "/register >password> >ConfirmPassword>" */
     REGISTER_MESSAGE("reg_msg"),
 
+    /** Please, register to the server with the command "/register >email> >confirmEmail>" */
     REGISTER_EMAIL_MESSAGE("reg_email_msg"),
 
+    /** You have exceeded the maximum number of registrations (%reg_count/%max_acc %reg_names) for your connection! */
     MAX_REGISTER_EXCEEDED("max_reg", "%max_acc", "%reg_count", "%reg_names"),
 
+    /** Usage: /register >password> >ConfirmPassword> */
     USAGE_REGISTER("usage_reg"),
 
+    /** Usage: /unregister >password> */
     USAGE_UNREGISTER("usage_unreg"),
 
+    /** Password changed successfully! */
     PASSWORD_CHANGED_SUCCESS("pwd_changed"),
 
+    /** This user isn't registered! */
     USER_NOT_REGISTERED("user_unknown"),
 
+    /** Passwords didn't match, check them again! */
     PASSWORD_MATCH_ERROR("password_error"),
 
+    /** You can't use your name as password, please choose another one... */
     PASSWORD_IS_USERNAME_ERROR("password_error_nick"),
 
+    /** The chosen password isn't safe, please choose another one... */
     PASSWORD_UNSAFE_ERROR("password_error_unsafe"),
 
+    /** Your password contains illegal characters. Allowed chars: REG_EX */
     PASSWORD_CHARACTERS_ERROR("password_error_chars", "REG_EX"),
 
+    /** Your IP has been changed and your session data has expired! */
     SESSION_EXPIRED("invalid_session"),
 
+    /** Only registered users can join the server! Please visit http://example.com to register yourself! */
     MUST_REGISTER_MESSAGE("reg_only"),
 
+    /** You're already logged in! */
     ALREADY_LOGGED_IN_ERROR("logged_in"),
 
+    /** Logged-out successfully! */
     LOGOUT_SUCCESS("logout"),
 
+    /** The same username is already playing on the server! */
     USERNAME_ALREADY_ONLINE_ERROR("same_nick"),
 
+    /** Successfully registered! */
     REGISTER_SUCCESS("registered"),
 
+    /** Your password is too short or too long! Please try with another one! */
     INVALID_PASSWORD_LENGTH("pass_len"),
 
+    /** Configuration and database have been reloaded correctly! */
     CONFIG_RELOAD_SUCCESS("reload"),
 
+    /** Login timeout exceeded, you have been kicked from the server, please try again! */
     LOGIN_TIMEOUT_ERROR("timeout"),
 
+    /** Usage: /changepassword >oldPassword> >newPassword> */
     USAGE_CHANGE_PASSWORD("usage_changepassword"),
 
+    /** Your username is either too short or too long! */
     INVALID_NAME_LENGTH("name_len"),
 
+    /** Your username contains illegal characters. Allowed chars: REG_EX */
     INVALID_NAME_CHARACTERS("regex", "REG_EX"),
 
+    /** Please add your email to your account with the command "/email add >yourEmail> >confirmEmail>" */
     ADD_EMAIL_MESSAGE("add_email"),
 
+    /** Forgot your password? Please use the command "/email recovery >yourEmail>" */
     FORGOT_PASSWORD_MESSAGE("recovery_email"),
 
+    /** To login you have to solve a captcha code, please use the command "/captcha >theCaptcha>" */
     USAGE_CAPTCHA("usage_captcha", "<theCaptcha>"),
 
+    /** Wrong captcha, please type "/captcha THE_CAPTCHA" into the chat! */
     CAPTCHA_WRONG_ERROR("wrong_captcha", "THE_CAPTCHA"),
 
+    /** Captcha code solved correctly! */
     CAPTCHA_SUCCESS("valid_captcha"),
 
+    /** A VIP player has joined the server when it was full! */
     KICK_FOR_VIP("kick_forvip"),
 
+    /** The server is full, try again later! */
     KICK_FULL_SERVER("kick_fullserver"),
 
+    /** Usage: /email add &gt;email> &gt;confirmEmail> */
     USAGE_ADD_EMAIL("usage_email_add"),
 
+    /** Usage: /email change &gt;oldEmail> &gt;newEmail> */
     USAGE_CHANGE_EMAIL("usage_email_change"),
 
+    /** Usage: /email recovery &gt;Email> */
     USAGE_RECOVER_EMAIL("usage_email_recovery"),
 
+    /** Invalid new email, try again! */
     INVALID_NEW_EMAIL("new_email_invalid"),
 
+    /** Invalid old email, try again! */
     INVALID_OLD_EMAIL("old_email_invalid"),
 
+    /** Invalid email address, try again! */
     INVALID_EMAIL("email_invalid"),
 
+    /** Email address successfully added to your account! */
     EMAIL_ADDED_SUCCESS("email_added"),
 
+    /** Please confirm your email address! */
     CONFIRM_EMAIL_MESSAGE("email_confirm"),
 
+    /** Email address changed correctly! */
     EMAIL_CHANGED_SUCCESS("email_changed"),
 
+    /** Your current email address is: %email */
     EMAIL_SHOW("email_show", "%email"),
 
+    /** You currently don't have email address associated with this account. */
     SHOW_NO_EMAIL("show_no_email"),
 
+    /** Recovery email sent successfully! Please check your email inbox! */
     RECOVERY_EMAIL_SENT_MESSAGE("email_send"),
 
+    /** A recovery email was already sent! You can discard it and send a new one using the command below: */
     RECOVERY_EMAIL_ALREADY_SENT_MESSAGE("email_exists"),
 
+    /** Your country is banned from this server! */
     COUNTRY_BANNED_ERROR("country_banned"),
 
+    /** [AntiBotService] AntiBot enabled due to the huge number of connections! */
     ANTIBOT_AUTO_ENABLED_MESSAGE("antibot_auto_enabled"),
 
+    /** [AntiBotService] AntiBot disabled after %m minutes! */
     ANTIBOT_AUTO_DISABLED_MESSAGE("antibot_auto_disabled", "%m"),
 
+    /** The email address is already being used */
     EMAIL_ALREADY_USED_ERROR("email_already_used"),
 
+    /** Your secret code is %code. You can scan it from here %url */
     TWO_FACTOR_CREATE("two_factor_create", "%code", "%url"),
 
+    /** You are not the owner of this account. Please choose another name! */
     NOT_OWNER_ERROR("not_owner_error"),
 
+    /** You should join using username %valid, not %invalid. */
     INVALID_NAME_CASE("invalid_name_case", "%valid", "%invalid"),
 
+    /** You have been temporarily banned for failing to log in too many times. */
     TEMPBAN_MAX_LOGINS("tempban_max_logins"),
 
+    /** You own %count accounts: */
     ACCOUNTS_OWNED_SELF("accounts_owned_self", "%count"),
 
+    /** The player %name has %count accounts: */
     ACCOUNTS_OWNED_OTHER("accounts_owned_other", "%name", "%count"),
 
+    /** An admin just registered you; please log in again */
     KICK_FOR_ADMIN_REGISTER("kicked_admin_registered"),
 
+    /** Error: not all required settings are set for sending emails. Please contact an admin. */
     INCOMPLETE_EMAIL_SETTINGS("incomplete_email_settings"),
 
+    /** The email could not be sent. Please contact an administrator. */
     EMAIL_SEND_FAILURE("email_send_failure"),
 
+    /** A recovery code to reset your password has been sent to your email. */
     RECOVERY_CODE_SENT("recovery_code_sent"),
 
+    /** The recovery code is not correct! Use /email recovery [email] to generate a new one */
     INCORRECT_RECOVERY_CODE("recovery_code_incorrect");
 
     private String key;

src/test/java/tools/messages/AddJavaDocToMessageEnumTask.java

@@ -0,0 +1,50 @@
+package tools.messages;
+
+import fr.xephi.authme.message.MessageKey;
+import org.bukkit.configuration.file.FileConfiguration;
+import org.bukkit.configuration.file.YamlConfiguration;
+import tools.utils.AutoToolTask;
+import tools.utils.ToolsConstants;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Task to add English messages as javadoc comment to each MessageKey enum entry.
+ */
+public class AddJavaDocToMessageEnumTask implements AutoToolTask {
+
+    private static final String MESSAGES_FILE = ToolsConstants.MAIN_RESOURCES_ROOT + "messages/messages_en.yml";
+
+    private FileConfiguration configuration;
+
+    @Override
+    public void executeDefault() {
+        configuration = YamlConfiguration.loadConfiguration(new File(MESSAGES_FILE));
+
+        List<String> entries = new ArrayList<>();
+        for (MessageKey entry : MessageKey.values()) {
+            String tags = entry.getTags().length == 0
+                ? ""
+                : ", \"" + String.join("\", \"", entry.getTags()) + "\"";
+
+            entries.add("/** " + getMessageForJavaDoc(entry) + " */"
+                + "\n\t" + entry.name() + "(\"" + entry.getKey() + "\"" + tags + ")");
+        }
+
+        System.out.println("\t" + String.join(",\n\n\t", entries) + ";");
+    }
+
+    @Override
+    public String getTaskName() {
+        return "addJavaDocToMessageEnum";
+    }
+
+    private String getMessageForJavaDoc(MessageKey key) {
+        return configuration.getString(key.getKey())
+            .replaceAll("&[0-9a-f]", "")
+            .replace("&", "&amp;")
+            .replace("<", "&gt;");
+    }
+}