Cleaned up the documentation a bit.

arcade/src/main/java/zone/themcgamer/arcade/manager/ArcadeManager.java

@@ -229,6 +229,7 @@ public class ArcadeManager extends Module {
 
     /**
      * Set the current game to the provided {@link Game}
+     *
      * @param game the game to set
      */
     public void setGame(Game game) {
@@ -247,6 +248,7 @@ public class ArcadeManager extends Module {
 
     /**
      * Start the game with the given countdown
+     *
      * @param countdown the countdown
      */
     public void startCountdown(int countdown) {
@@ -291,6 +293,7 @@ public class ArcadeManager extends Module {
 
     /**
      * Set the game state to the given {@link GameState}
+     *
      * @param state the state to set
      */
     private void setState(GameState state) {

commons/src/main/java/zone/themcgamer/common/DoubleUtils.java

@@ -9,6 +9,7 @@ import java.util.List;
 public class DoubleUtils {
     /**
      * Format the given value into a readable format
+     *
      * @param amount the value to format
      * @param shortSuffixes whether or not to have shorrt suffixes
      * @return the formatted value

commons/src/main/java/zone/themcgamer/common/EnumUtils.java

@@ -10,6 +10,7 @@ import org.jetbrains.annotations.Nullable;
 public class EnumUtils {
     /**
      * Get the enum value from the given class with the given name
+     *
      * @param clazz - The enum class
      * @param name - The name
      * @return the enum value

commons/src/main/java/zone/themcgamer/common/HashUtils.java

@@ -9,6 +9,7 @@ import java.security.NoSuchAlgorithmException;
 public class HashUtils {
     /**
      * Encrypt the given {@link String} as SHA-256
+     *
      * @param s the string to encrypt
      * @return the encrypted string
      */

commons/src/main/java/zone/themcgamer/common/MiscUtils.java

@@ -10,6 +10,7 @@ import java.util.UUID;
 public class MiscUtils {
     /**
      * Get a {@link String} based on the provided string array
+     *
      * @param array - The string array
      * @return the string
      */
@@ -19,6 +20,7 @@ public class MiscUtils {
 
     /**
      * Get a {@link String} based on the provided {@link List<String>}
+     *
      * @param list - The string list
      * @return the string
      */

commons/src/main/java/zone/themcgamer/common/RandomUtils.java

@@ -14,6 +14,7 @@ import java.util.concurrent.ThreadLocalRandom;
 public class RandomUtils {
     /**
      * Return whether or not the {@param chance} has been met
+     *
      * @param chance - The chance
      * @param max - The maximum number
      * @return whether or not the {@param chance} has been met
@@ -24,6 +25,7 @@ public class RandomUtils {
 
     /**
      * Return whether or not the {@param chance} has been met
+     *
      * @param chance - The chance
      * @param max - The maximum number
      * @return whether or not the {@param chance} has been met
@@ -34,6 +36,7 @@ public class RandomUtils {
 
     /**
      * Get a random int between 0 and the maximum value
+     *
      * @param max - The maximum value
      * @return the random number
      */
@@ -43,6 +46,7 @@ public class RandomUtils {
 
     /**
      * Get a random int between the minimum and maximum values
+     *
      * @param min - The minimum value
      * @param max - The maximum value
      * @return the random number
@@ -53,6 +57,7 @@ public class RandomUtils {
 
     /**
      * Get a random long between 0 and the maximum value
+     *
      * @param max - The maximum value
      * @return the random number
      */
@@ -62,6 +67,7 @@ public class RandomUtils {
 
     /**
      * Get a random long between the minimum and maximum values
+     *
      * @param min - The minimum value
      * @param max - The maximum value
      * @return the random number
@@ -72,6 +78,7 @@ public class RandomUtils {
 
     /**
      * Get a random double between 0 and the maximum value
+     *
      * @param max - The maximum value
      * @return the random number
      */
@@ -81,6 +88,7 @@ public class RandomUtils {
 
     /**
      * Get a random double between the minimum and maximum values
+     *
      * @param min - The minimum value
      * @param max - The maximum value
      * @return the random number
@@ -91,6 +99,7 @@ public class RandomUtils {
 
     /**
      * Select a random {@link Enum<T>} value from the given
+     *
      * {@link Enum<T>} class
      * @param enumClass - The enum class
      * @return the random enum value
@@ -104,6 +113,7 @@ public class RandomUtils {
 
     /**
      * Select a random {@link Object} from the provided {@link java.util.ArrayList}
+     *
      * @param list - The list to get the object from
      * @return the random object
      */

commons/src/main/java/zone/themcgamer/common/TimeUtils.java

@@ -8,6 +8,7 @@ import java.text.SimpleDateFormat;
 public class TimeUtils {
     /**
      * Format the given time as a date and time {@link String}
+     *
      * @param time the time to format
      * @return the formatted time
      */
@@ -33,6 +34,7 @@ public class TimeUtils {
 
     /**
      * Convert the provided unix time into readable time such as "1.0 Minute"
+     *
      * @param time - The unix time to convert
      * @return the formatted time
      */
@@ -42,6 +44,7 @@ public class TimeUtils {
 
     /**
      * Convert the provided unix time into readable time such as "1.0 Minute"
+     *
      * @param time - The unix time to convert
      * @param includeDecimals - Whether or not to format the time with decimals
      * @param type - The type to format the time as. Use {@code TimeUnit.FIT} for

commons/src/main/java/zone/themcgamer/common/ZipUtils.java

@@ -15,6 +15,7 @@ import java.util.zip.ZipOutputStream;
 public class ZipUtils {
     /**
      * Zip the given directory
+     *
      * @param sourceDirectoryPath the path of the directory to zip
      * @param zipDirectoryPath the path of the output file
      */

core/src/main/java/zone/themcgamer/core/account/AccountManager.java

@@ -269,6 +269,7 @@ public class AccountManager extends Module {
 
     /**
      * Lookup a {@link Account} with the given username
+     *
      * @param name the name of the account to lookup
      * @param consumer the account consumer
      */
@@ -290,6 +291,7 @@ public class AccountManager extends Module {
 
     /**
      * Lookup a {@link Account} with the given {@link UUID}
+     *
      * @param uuid the uuid of the account to lookup
      * @param name the name of the account to lookup
      * @param consumer the account consumer
@@ -341,6 +343,7 @@ public class AccountManager extends Module {
 
     /**
      * Add the given {@link MiniAccount}
+     *
      * @param miniAccount the mini account to add
      */
     public static void addMiniAccount(MiniAccount<?> miniAccount) {
@@ -349,6 +352,7 @@ public class AccountManager extends Module {
 
     /**
      * Get the {@link Account} from the provided uuid
+     *
      * @param uuid the uuid to get the account for
      * @return the optional account
      */

core/src/main/java/zone/themcgamer/core/account/AccountRepository.java

@@ -42,6 +42,7 @@ public class AccountRepository extends MySQLRepository {
 
     /**
      * Attempt a login with the given uuid, name, and ip address
+     *
      * @param uuid the uuid
      * @param name the username
      * @param ipAddress the ip address
@@ -185,6 +186,7 @@ public class AccountRepository extends MySQLRepository {
 
     /**
      * Construct a {@link Account} from the given parameters
+     *
      * @param accountId the account id
      * @param uuid the uuid
      * @param name the name

core/src/main/java/zone/themcgamer/core/animation/impl/WaveAnimation.java

@@ -18,6 +18,7 @@ public class WaveAnimation extends TextAnimation {
 
     /**
      * Add a primary color to the animation
+     *
      * @param color the color to add
      */
     public WaveAnimation withPrimary(String color) {
@@ -27,6 +28,7 @@ public class WaveAnimation extends TextAnimation {
 
     /**
      * Add a secondary color to the animation
+     *
      * @param color the color to add
      */
     public WaveAnimation withSecondary(String color) {
@@ -36,6 +38,7 @@ public class WaveAnimation extends TextAnimation {
 
     /**
      * Add a third (highlight) color to the animation
+     *
      * @param color the color to add
      */
     public WaveAnimation withTertiary(String color) {
@@ -53,6 +56,7 @@ public class WaveAnimation extends TextAnimation {
 
     /**
      * Animate the animation and return the new text
+     *
      * @return the text
      */
     @Override
@@ -72,6 +76,7 @@ public class WaveAnimation extends TextAnimation {
 
     /**
      * Get the frames for the text with the given primary and secondary colors
+     *
      * @param primary the primary color
      * @param secondary the secondary color
      * @return the frames

core/src/main/java/zone/themcgamer/core/api/WebAPI.java

@@ -3,11 +3,14 @@ package zone.themcgamer.core.api;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import lombok.NonNull;
+import org.apache.commons.lang3.StringEscapeUtils;
 import zone.themcgamer.core.api.json.JsonRequest;
 import zone.themcgamer.core.api.json.JsonResponse;
 import zone.themcgamer.data.ChatFilterLevel;
 
+import java.net.URLEncoder;
 import java.net.http.HttpClient;
+import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 
 /**
@@ -27,7 +30,8 @@ public class WebAPI {
     }
 
     public static String filterText(@NonNull String text, @NonNull ChatFilterLevel chatFilterLevel) {
-        JsonResponse jsonResponse = new JsonRequest(URL + "/filter/" + text.replaceAll(" ", "%20") + "/" + chatFilterLevel.name()).getResponse();
+        // TODO: 3/17/2021 debug this
+        JsonResponse jsonResponse = new JsonRequest(URLEncoder.encode(URL + "/filter/" + text.replaceAll(" ", "%20") + "/" + chatFilterLevel.name(), StandardCharsets.UTF_8)).getResponse();
         JsonElement jsonElement = jsonResponse.getJsonElement();
         if (!(jsonElement instanceof JsonObject))
             return text;

core/src/main/java/zone/themcgamer/core/badSportSystem/BadSportClient.java

@@ -22,6 +22,7 @@ public class BadSportClient {
 
     /**
      * Get the currently active ban
+     *
      * @return the optional ban
      */
     public Optional<Punishment> getBan() {
@@ -31,6 +32,7 @@ public class BadSportClient {
 
     /**
      * Get the currently active mute
+     *
      * @return the optional mute
      */
     public Optional<Punishment> getMute() {
@@ -39,6 +41,7 @@ public class BadSportClient {
 
     /**
      * Get an optional {@link Punishment} that matches against the {@link Predicate}
+     *
      * @param predicate the predicate to test against
      * @return the optional punishment
      */
@@ -51,6 +54,7 @@ public class BadSportClient {
 
     /**
      * Get a {@link Collection} of punishments that matches against the {@link Predicate}
+     *
      * @param predicate the predicate to test against
      * @return the collection of punishments
      */

core/src/main/java/zone/themcgamer/core/badSportSystem/BadSportRepository.java

@@ -27,6 +27,7 @@ public class BadSportRepository extends MySQLRepository {
 
     /**
      * Post a {@link Punishment} to MySQL
+     *
      * @param punishment the punishment
      */
     public void punish(Punishment punishment, Consumer<Integer> idConsumer) {
@@ -47,6 +48,7 @@ public class BadSportRepository extends MySQLRepository {
 
     /**
      * Post a {@link Punishment} to MySQL
+     *
      * @param encryptedIpAddress the target encrypted ip of the punishment
      * @param uuid the target uuid of the punishment
      * @param category the category of the punishment

core/src/main/java/zone/themcgamer/core/badSportSystem/BadSportSystem.java

@@ -153,6 +153,7 @@ public class BadSportSystem extends Module {
 
     /**
      * Get the {@link BadSportClient} account for the given {@link UUID}
+     *
      * @param uuid the uuid of the account
      * @return the optional account
      */

core/src/main/java/zone/themcgamer/core/command/BukkitCommand.java

@@ -10,6 +10,7 @@ import java.util.List;
 /**
  * This class is an override for the default {@link org.bukkit.command.defaults.BukkitCommand}
  * class
+ *
  * @author Braydon
  */
 public class BukkitCommand extends Command {

core/src/main/java/zone/themcgamer/core/command/BukkitCompleter.java

@@ -13,6 +13,7 @@ import java.util.Map;
 
 /**
  * This class is an override for the default class
+ *
  * @author Braydon
  */
 public class BukkitCompleter implements TabCompleter {

core/src/main/java/zone/themcgamer/core/command/Command.java

@@ -9,6 +9,7 @@ import java.lang.annotation.Target;
 
 /**
  * This annotation holds information for a command
+ *
  * @author Braydon
  */
 @Target(ElementType.METHOD)

core/src/main/java/zone/themcgamer/core/command/CommandManager.java

@@ -146,6 +146,7 @@ public class CommandManager extends Module implements CommandExecutor {
 
     /**
      * Register a command
+     *
      * @param plugin - The owner of the command
      * @param object - The instance of the command class
      */
@@ -159,6 +160,7 @@ public class CommandManager extends Module implements CommandExecutor {
 
     /**
      * Add all of the currently registered commands to the help menu
+     *
      * @param plugin - The plugin owner of the commands to add to
      *                 the help menu
      */

core/src/main/java/zone/themcgamer/core/command/CommandProvider.java

@@ -7,6 +7,7 @@ import org.bukkit.entity.Player;
 /**
  * This class is constructed everytime a command is executed.
  * It holds information such as the sender, label, and arguments
+ *
  * @author Braydon
  */
 @Getter

core/src/main/java/zone/themcgamer/core/command/TabComplete.java

@@ -7,6 +7,7 @@ import java.lang.annotation.Target;
 
 /**
  * This annotation holds information for a command tab completer
+ *
  * @author Braydon
  */
 @Target(ElementType.METHOD)

core/src/main/java/zone/themcgamer/core/command/help/HelpColorScheme.java

@@ -5,6 +5,7 @@ import lombok.Getter;
 
 /**
  * This class holds information for a help menu color scheme
+ *
  * @author Braydon
  */
 @AllArgsConstructor @Getter

core/src/main/java/zone/themcgamer/core/command/help/HelpCommand.java

@@ -15,11 +15,13 @@ import java.util.List;
  * to the executor. The {@code sendHelp} method can be overridden
  * inside of a command class so that command can have it's own help
  * menu instead of the default one
+ *
  * @author Braydon
  */
 public class HelpCommand {
     /**
      * Get the color scheme for the help menu
+     *
      * @return the color scheme
      */
     public HelpColorScheme getColorScheme() {
@@ -28,6 +30,7 @@ public class HelpCommand {
 
     /**
      * Send the help menu to the provided sender
+     *
      * @param sender - The sender to send the help menu to
      * @param label - The command label
      * @param parent - The parent command

core/src/main/java/zone/themcgamer/core/common/BlockTag.java

@@ -95,6 +95,7 @@ public enum BlockTag {
 
     /**
      * Check if the given {@link Block} {@link Material} is apart of this {@link BlockTag}
+     *
      * @param block the block to check
      * @return if the block material is apart of this tag
      */
@@ -104,6 +105,7 @@ public enum BlockTag {
 
     /**
      * Check if the given {@link Material} is apart of this {@link BlockTag}
+     *
      * @param material the material to check
      * @return if the material is apart of this tag
      */
@@ -113,6 +115,7 @@ public enum BlockTag {
 
     /**
      * Check if the given {@link XMaterial} is apart of this {@link BlockTag}
+     *
      * @param material the material to check
      * @return if the material is apart of this tag
      */

core/src/main/java/zone/themcgamer/core/common/HiddenStringUtils.java

@@ -16,6 +16,7 @@ public class HiddenStringUtils {
     /**
      * Encode the given {@link String} and return the
      * encoded string
+     *
      * @param s - The string to encode
      * @return the encoded string
      */
@@ -28,6 +29,7 @@ public class HiddenStringUtils {
     /**
      * Replace the given from hidden {@link String} with
      * the to {@link String}
+     *
      * @param from - The from
      * @param to - The to
      * @return the replaced string
@@ -45,6 +47,7 @@ public class HiddenStringUtils {
     /**
      * Get whether or not the provided {@link String} is
      * a hidden {@link String}
+     *
      * @param s - The string to check
      * @return whether or not the {@link String} is a hidden {@link String}
      */
@@ -56,6 +59,7 @@ public class HiddenStringUtils {
 
     /**
      * Decode the given {@link String}
+     * 
      * @param s - The string to decode
      * @return the decoded string
      */

core/src/main/java/zone/themcgamer/core/common/ItemBuilder.java

@@ -22,6 +22,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder from an existing {@link ItemStack}
+     *
      * @param item - The {@link ItemStack} you would like to create the item builder with
      */
     public ItemBuilder(ItemStack item) {
@@ -30,6 +31,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link XMaterial}
+     *
      * @param xMaterial - The {@link XMaterial} of the item you would like to create
      */
     public ItemBuilder(XMaterial xMaterial) {
@@ -38,6 +40,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link Material}
+     *
      * @param material - The {@link Material} of the item you would like to create
      */
     public ItemBuilder(Material material) {
@@ -46,6 +49,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link XMaterial}, and amount
+     *
      * @param xMaterial - The {@link XMaterial} of the item you would like to create
      * @param amount - The amount of the item you would like to create
      */
@@ -58,6 +62,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link Material}, and amount
+     *
      * @param material - The {@link Material} of the item you would like to create
      * @param amount - The amount of the item you would like to create
      */
@@ -67,6 +72,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link XMaterial}, amount, and dye color
+     *
      * @param xMaterial - The {@link XMaterial} of the item you would like to create
      * @param amount - The amount of the item you would like to create
      * @param color - The dye color of the item you would like to create
@@ -77,6 +83,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link Material}, amount, and dye color
+     *
      * @param material - The {@link Material} of the item you would like to create
      * @param amount - The amount of the item you would like to create
      * @param color - The dye color of the item you would like to create
@@ -87,6 +94,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link XMaterial}, amount, and data
+     *
      * @param xMaterial - The {@link XMaterial} of the item you would like to create
      * @param amount - The amount of the item you would like to create
      * @param data - The data of the item you would like to create
@@ -100,6 +108,7 @@ public class ItemBuilder {
 
     /**
      * Create a new item builder with the provided {@link Material}, amount, and data
+     *
      * @param material - The {@link Material} of the item you would like to create
      * @param amount - The amount of the item you would like to create
      * @param data - The data of the item you would like to create
@@ -110,6 +119,7 @@ public class ItemBuilder {
 
     /**
      * Sets the type of your item to the provided {@link XMaterial}
+     *
      * @param xMaterial - The {@link XMaterial} you would like to set your item to
      * @return the item builder
      */
@@ -122,6 +132,7 @@ public class ItemBuilder {
 
     /**
      * Sets the type of your item to the provided {@link Material}
+     *
      * @param material - The {@link Material} you would like to set your item to
      * @return the item builder
      */
@@ -132,6 +143,7 @@ public class ItemBuilder {
 
     /**
      * Sets the data of your item to the provided data
+     *
      * @param data - The data you would like to set your item to
      * @return the item builder
      */
@@ -142,6 +154,7 @@ public class ItemBuilder {
 
     /**
      * Sets the display name of your item to the provided string
+     *
      * @param name - The name you would like to set your item to
      * @return the item builder
      */
@@ -156,6 +169,7 @@ public class ItemBuilder {
 
     /**
      * Sets the lore of your item to the provided string array
+     *
      * @param array - The array of strings you would like to set your lore to
      * @return the item builder
      */
@@ -165,6 +179,7 @@ public class ItemBuilder {
 
     /**
      * Sets the lore of your item to the provided string list
+     *
      * @param list - The list of strings you would like to set your lore to
      * @return the item builder
      */
@@ -177,6 +192,7 @@ public class ItemBuilder {
 
     /**
      * Add a string to the item lore at the provided index
+     *
      * @param index - The index you would like to add the lore line to
      * @param s - The text you would like to add at the provided index
      * @return the item builder
@@ -192,6 +208,7 @@ public class ItemBuilder {
 
     /**
      * Add a string to the item lore
+     *
      * @param s - The text you would like to add to your item lore
      * @return the item builder
      */
@@ -208,6 +225,7 @@ public class ItemBuilder {
 
     /**
      * Remove a string from the lore at the provided index
+     *
      * @param index - The index you would like to remove the lore line from
      * @return the item builder
      */
@@ -224,6 +242,7 @@ public class ItemBuilder {
 
     /**
      * Remove a string from the lore that matches the provided string
+     *
      * @param s - The string you would like to remove from the lore
      * @return the item builder
      */
@@ -240,6 +259,7 @@ public class ItemBuilder {
 
     /**
      * Clears the item lore
+     *
      * @return the item builder
      */
     public ItemBuilder clearLore() {
@@ -253,6 +273,7 @@ public class ItemBuilder {
 
     /**
      * Set the amount of the itemstack
+     *
      * @param amount - The amount you would like your item to be
      * @return the item builder
      */
@@ -263,6 +284,7 @@ public class ItemBuilder {
 
     /**
      * Set the durability of the itemstack
+     *
      * @param durability - The durability you would like your item to have
      * @return the item builder
      */
@@ -273,6 +295,7 @@ public class ItemBuilder {
 
     /**
      * Add a glow effect to your item
+     *
      * @return the item builder
      */
     public ItemBuilder addGlow() {
@@ -281,6 +304,7 @@ public class ItemBuilder {
 
     /**
      * Add a glow effect to your item
+     *
      * @return the item builder
      */
     public ItemBuilder setGlow(boolean glow) {
@@ -298,6 +322,7 @@ public class ItemBuilder {
 
     /**
      * Adds enchantments to your item from a map ({@link XEnchantment}, {@link Integer})
+     *
      * @param enchantments - A map of enchantments with the key as the enchant, and the value as the level
      * @return the item builder
      */
@@ -314,6 +339,7 @@ public class ItemBuilder {
 
     /**
      * Adds enchantments to your item from a map ({@link Enchantment}, {@link Integer})
+     *
      * @param enchantments - A map of enchantments with the key as the enchant, and the value as the level
      * @return the item builder
      */
@@ -324,6 +350,7 @@ public class ItemBuilder {
 
     /**
      * Add an enchantment to your item
+     *
      * @param xEnchantment - The {@link XEnchantment} you would like to add
      * @param level - The level of the enchantment to add
      * @return the item builder
@@ -337,6 +364,7 @@ public class ItemBuilder {
 
     /**
      * Add an enchantment to your item
+     *
      * @param enchantment - The {@link Enchantment} you would like to add
      * @param level - The level of the enchantment to add
      * @return the item builder
@@ -350,6 +378,7 @@ public class ItemBuilder {
 
     /**
      * Add an unsafe enchantment to your item
+     *
      * @param xEnchantment - The {@link XEnchantment} you would like to add
      * @param level - The level of the enchant
      * @return the item builder
@@ -363,6 +392,7 @@ public class ItemBuilder {
 
     /**
      * Add an unsafe enchantment to your item
+     *
      * @param enchantment - The {@link Enchantment} you would like to add
      * @param level - The level of the enchant
      * @return the item builder
@@ -374,6 +404,7 @@ public class ItemBuilder {
 
     /**
      * Remove an enchantment from your item
+     *
      * @param xEnchantment - The {@link XEnchantment} you would like to remove
      * @return the item builder
      */
@@ -386,6 +417,7 @@ public class ItemBuilder {
 
     /**
      * Remove an enchantment from your item
+     *
      * @param enchantment - The {@link Enchantment} you would like to remove
      * @return the item builder
      */
@@ -397,6 +429,7 @@ public class ItemBuilder {
 
     /**
      * Clear all enchantments from your item
+     *
      * @return the item builder
      */
     public ItemBuilder clearEnchantments() {
@@ -408,6 +441,7 @@ public class ItemBuilder {
 
     /**
      * Set the skull texture of your item with the provided player's skin
+     *
      * @param identifier - The identifier for the skull
      * @return the item builder
      */
@@ -423,6 +457,7 @@ public class ItemBuilder {
 
     /**
      * Set the color of your item
+     *
      * @param color - The color you would like to set your leather armor to
      * @return the item builder
      */
@@ -437,6 +472,7 @@ public class ItemBuilder {
 
     /**
      * Create the item we just created with the item builder
+     *
      * @return the constructed {@link ItemStack}
      */
     public ItemStack toItemStack() {

core/src/main/java/zone/themcgamer/core/common/LocationUtils.java

@@ -10,6 +10,7 @@ import org.bukkit.World;
 public class LocationUtils {
     /**
      * Serialize the given {@link Location}
+     *
      * @param location the location to serialize
      * @return the serialized location
      */
@@ -26,6 +27,7 @@ public class LocationUtils {
 
     /**
      * Deserialize the given {@link String}
+     *
      * @param s the string to deserialize
      * @return the deserialized {@link Location}
      */

core/src/main/java/zone/themcgamer/core/common/MiscUtils.java

@@ -8,6 +8,7 @@ import java.text.DecimalFormat;
 public class MiscUtils {
     /**
      * Format the given tps value
+     *
      * @param tps the tps
      * @return the formatted tps
      */

core/src/main/java/zone/themcgamer/core/common/MojangUtils.java

@@ -45,6 +45,7 @@ public class MojangUtils {
 
     /**
      * Get the Mojang service statuses
+     *
      * @return service statuses
      */
     public static Map<MojangService, ServiceStatus> getServiceStatus() {
@@ -84,6 +85,7 @@ public class MojangUtils {
 
     /**
      * Get the {@link UUID} of the given player
+     *
      * @param playerName - The name of the player to get the uuid for
      * @return the uuid
      */
@@ -116,6 +118,7 @@ public class MojangUtils {
 
     /**
      * Get the {@link UUID} of the given player asynchronously
+     *
      * @param playerName - The name of the player to get the uuid for
      * @param callback - The consumer that that will contain the uuid response, null if none
      */
@@ -157,6 +160,7 @@ public class MojangUtils {
 
     /**
      * Get a list of changes names for the given uuid
+     *
      * The response is: name, timestamp (-1 if first name)
      * @param uuid - The {@link UUID} to get the changed names for
      * @return the changed names
@@ -191,6 +195,7 @@ public class MojangUtils {
     /**
      * Get a list of changes names for the given uuid asynchronously
      * The response is: name, timestamp (-1 if first name)
+     *
      * @param uuid - The {@link UUID} to get the changed names for
      * @param callback - The consumer that that will contain the list of changed names
      */
@@ -233,6 +238,7 @@ public class MojangUtils {
 
     /**
      * Get the skin textures for the given {@link UUID}
+     *
      * @param uuid - The uuid to get the textures for
      * @return the skin data
      */
@@ -264,6 +270,7 @@ public class MojangUtils {
 
     /**
      * Get the skin textures for the given {@link UUID} asynchronously
+     *
      * @param uuid - The uuid to get the textures for
      * @param callback - The consumer that that will contain the skin data
      */
@@ -307,6 +314,7 @@ public class MojangUtils {
 
     /**
      * Parse a uuid without dashes to a proper {@link UUID}
+     *
      * @param s - The un-parsed uuid
      * @return the uuid
      */

core/src/main/java/zone/themcgamer/core/common/PageBuilder.java

@@ -20,6 +20,7 @@ public class PageBuilder<T> {
 
     /**
      * Set the results per page
+     *
      * @param resultsPerPage the results per page
      */
     public PageBuilder<T> resultsPerPage(int resultsPerPage) {
@@ -29,6 +30,7 @@ public class PageBuilder<T> {
 
     /**
      * Get the maximum number of pages
+     *
      * @return the maximum number of pages
      */
     public int getMaxPages() {

core/src/main/java/zone/themcgamer/core/common/PlayerUtils.java

@@ -10,6 +10,7 @@ import org.bukkit.potion.PotionEffect;
 public class PlayerUtils {
     /**
      * Reset the given {@link Player} to it's original state
+     *
      * @param player the player to reset
      * @param effects whether or not to clear the player's effects
      * @param inventory whether or not to clear the player's inventory

core/src/main/java/zone/themcgamer/core/common/ServerUtils.java

@@ -32,6 +32,7 @@ public class ServerUtils {
 
     /**
      * Get the current tps of the server
+     *
      * @return the tps
      */
     public static double getTps() {

core/src/main/java/zone/themcgamer/core/common/Style.java

@@ -13,6 +13,7 @@ import java.util.List;
 public class Style {
     /**
      * Return the rank required message for the given player name with the given prefix
+     *
      * @return the rank required message.
      * @param rank the rank that is required
      */
@@ -27,6 +28,7 @@ public class Style {
 
     /**
      * Return the invalid account error for the given player name with the given prefix
+     *
      * @param prefix the prefix
      * @param playerName the player name
      * @return the error
@@ -37,6 +39,7 @@ public class Style {
 
     /**
      * Return the default chat format with the given prefix and message
+     *
      * @param prefix the prefix of the message
      * @param message the message
      * @return the formatted message
@@ -47,6 +50,7 @@ public class Style {
 
     /**
      * Return the default error chat format with the given prefix and message
+     *
      * @param prefix the prefix of the message
      * @param message the message
      * @return the formatted message
@@ -57,6 +61,7 @@ public class Style {
 
     /**
      * Color the provided {@link Collection<String>} using {@link ChatColor}
+     *
      * @param lines the lines to color
      * @return the colored lines
      */
@@ -69,6 +74,7 @@ public class Style {
 
     /**
      * Color the provided message using {@link ChatColor}
+     *
      * @param message the message to color
      * @return the colored message
      */

core/src/main/java/zone/themcgamer/core/common/WorldTime.java

@@ -4,7 +4,7 @@ import lombok.AllArgsConstructor;
 import lombok.Getter;
 
 @AllArgsConstructor @Getter
-public enum  WorldTime {
+public enum WorldTime {
     SUNRISE("Sunrise", new String[] {
             "&7Beginning of the Minecraft day.",
             "&7Villagers awaken and rise from their beds."

core/src/main/java/zone/themcgamer/core/common/menu/Button.java

@@ -11,6 +11,7 @@ import java.util.function.Consumer;
 /**
  * This class holds the {@link ItemStack} and {@link Consumer} for
  * the {@link InventoryClickEvent} for each button
+ *
  * @author Braydon
  */
 @RequiredArgsConstructor @AllArgsConstructor @Getter

core/src/main/java/zone/themcgamer/core/common/menu/Menu.java

@@ -80,6 +80,7 @@ public abstract class Menu {
 
     /**
      * Add the defined flag to the menu
+     *
      * @param flag - The flag to add
      */
     protected void addFlag(MenuFlag flag) {
@@ -88,6 +89,7 @@ public abstract class Menu {
 
     /**
      * Get whether the menu has the defined flag
+     *
      * @param flag - The flag to check
      * @return whether the menu has the flag
      */
@@ -97,6 +99,7 @@ public abstract class Menu {
 
     /**
      * Remove the defined flag from the menu
+     *
      * @param flag - The flag to remove
      */
     protected void removeFlag(MenuFlag flag) {
@@ -105,6 +108,7 @@ public abstract class Menu {
 
     /**
      * Fill the menu with the given button
+     *
      * @param button - The button to fill the menu with
      */
     protected void fill(Button button) {
@@ -115,6 +119,7 @@ public abstract class Menu {
 
     /**
      * Fill the menu with the given button at the given slots.
+     *
      * @see MenuPattern to get a list of slots
      * @param slots - The slots to fill
      * @param button - The button to fill the slots with
@@ -127,6 +132,7 @@ public abstract class Menu {
 
     /**
      * Fill the borders of the menu with the given button
+     *
      * @param button - The button to fill the borders with
      * @author NoneTaken
      */
@@ -147,6 +153,7 @@ public abstract class Menu {
 
     /**
      * Fill the slots at the given column with the given button
+     *
      * @param column - The column to fill
      * @param button - The button to fill the column with
      */
@@ -160,6 +167,7 @@ public abstract class Menu {
 
     /**
      * Fill the slots at the given row with the given button
+     *
      * @param row - The row to fill
      * @param button - The button to fill the row with
      */
@@ -173,6 +181,7 @@ public abstract class Menu {
 
     /**
      * Add a {@link Button} to the next available slot in the menu
+     *
      * @param button the button to add
      */
     public void add(Button button) {
@@ -186,6 +195,7 @@ public abstract class Menu {
 
     /**
      * Set the slot at the given column and row to the given button
+     *
      * @param column - The column
      * @param row - The row
      * @param button - The button to set
@@ -196,6 +206,7 @@ public abstract class Menu {
 
     /**
      * Set the given slot in the menu to the given button
+     *
      * @param slot - The slot to set the button in
      * @param button - The button
      */
@@ -216,6 +227,7 @@ public abstract class Menu {
 
     /**
      * Get the button at the given column and row
+     *
      * @param column - The column
      * @param row - The row
      * @return the button
@@ -227,6 +239,7 @@ public abstract class Menu {
 
     /**
      * Get the button at the given slot
+     *
      * @param slot - The slot to get the button for
      * @return the button
      */
@@ -246,6 +259,7 @@ public abstract class Menu {
 
     /**
      * Get the opened menu for the given player
+     *
      * @param player - The player to get the menu for
      * @return the menu
      */

core/src/main/java/zone/themcgamer/core/common/menu/MenuPattern.java

@@ -14,6 +14,7 @@ public class MenuPattern {
      * Get the slots matching the given pattern.
      * Example: 'XXOOOOOXX' would return slots
      * from 1 to 6 for that pattern
+     *
      * @param patterns - The patterns
      * @return the slots
      */

core/src/main/java/zone/themcgamer/core/common/menu/PaginatedMenu.java

@@ -35,6 +35,7 @@ public abstract class PaginatedMenu<T> extends Menu {
 
     /**
      * Calculate and return what the max page is
+     *
      * @return the max page
      */
     protected int getMaxPage() {
@@ -44,6 +45,7 @@ public abstract class PaginatedMenu<T> extends Menu {
 
     /**
      * Populate the contents map with the position and value
+     *
      * @param itemsPerPage - The amount of items to display per page
      */
     private void populateContents(int itemsPerPage) {

core/src/main/java/zone/themcgamer/core/common/scoreboard/ScoreboardEntry.java

@@ -18,6 +18,7 @@ public class ScoreboardEntry {
     /**
      * Creates a new scoreboard line with the provided text for the
      * provided scoreboard provider
+     *
      * @param provider - The scoreboard provider you would like to make the line for
      * @param text - The text you would like to be displayed for this line
      */
@@ -55,6 +56,7 @@ public class ScoreboardEntry {
 
     /**
      * Display the line at the provided position
+     *
      * @param position - The position you would like to display the line at
      */
     protected void display(int position) {

core/src/main/java/zone/themcgamer/core/common/scoreboard/ScoreboardHandler.java

@@ -135,6 +135,7 @@ public class ScoreboardHandler implements Listener {
 
     /**
      * Give the provided player the scoreboard
+     *
      * @param player - The player you would like to give the scoreboard to
      */
     public void giveBoard(Player player) {
@@ -150,6 +151,7 @@ public class ScoreboardHandler implements Listener {
 
     /**
      * Remove the scoreboard from the provided player
+     *
      * @param player - The player you would like to remove the scoreboard from
      */
     public void removeBoard(Player player) {

core/src/main/java/zone/themcgamer/core/common/scoreboard/ScoreboardProvider.java

@@ -32,6 +32,7 @@ public abstract class ScoreboardProvider {
 
     /**
      * Get an entry at the provided index
+     *
      * @param index - The index of the entry you would like to get
      * @return the entry at the provided index, null if none
      */
@@ -43,6 +44,7 @@ public abstract class ScoreboardProvider {
 
     /**
      * Get a unique name for a team
+     *
      * @return the unique name for a team
      */
     public String getTeamName() {

core/src/main/java/zone/themcgamer/core/game/MGZGame.java

@@ -97,6 +97,7 @@ public enum MGZGame {
 
     /**
      * Get the amount of players playing this game
+     *
      * @return the amount of players playing
      */
     public int getPlaying() {
@@ -115,6 +116,7 @@ public enum MGZGame {
 
     /**
      * Get the best {@link MinecraftServer} to join for this game
+     *
      * @return the optional server
      */
     public Optional<MinecraftServer> getBestServer() {

core/src/main/java/zone/themcgamer/core/module/Module.java

@@ -51,6 +51,7 @@ public abstract class Module implements Listener {
 
     /**
      * Log a message to the terminal for this module
+     *
      * @param message the message to log
      */
     public void log(String message) {
@@ -59,6 +60,7 @@ public abstract class Module implements Listener {
 
     /**
      * Get the module by the provided class
+     *
      * @param clazz the class of the module to get
      * @return the module
      */

core/src/main/java/zone/themcgamer/core/nametag/protocol/PacketAccessor.java

@@ -73,6 +73,7 @@ public class PacketAccessor {
 
     /**
      * Create a new instance of {@link PacketPlayOutScoreboardTeam}
+     *
      * @return the new instance
      */
     public static Object createPacket() {
@@ -86,6 +87,7 @@ public class PacketAccessor {
 
     /**
      * Send the given packet to the {@link Collection<Player>}
+     *
      * @param players the players to send the packet to
      * @param packet the packet to send
      */
@@ -96,6 +98,7 @@ public class PacketAccessor {
 
     /**
      * Send a packet to the given {@link Player}
+     *
      * @param player the player to send the packet to
      * @param packet the packet to send
      */
@@ -111,6 +114,7 @@ public class PacketAccessor {
 
     /**
      * Get a field in the packet by the given name
+     *
      * @param name the name of the field
      * @return the field
      * @throws Exception the exception

core/src/main/java/zone/themcgamer/core/nametag/protocol/PacketWrapper.java

@@ -91,6 +91,7 @@ public class PacketWrapper {
 
     /**
      * Send the wrapped packet to the given {@link Player}
+     *
      * @param player the player to send the wrapped packet to
      */
     public void send(Player player) {

core/src/main/java/zone/themcgamer/core/nametag/team/FakeTeam.java

@@ -66,6 +66,7 @@ public class FakeTeam {
 
     /**
      * Add the given {@link Player} to the team
+     *
      * @param player the player to add
      */
     public void addMember(Player player) {
@@ -74,6 +75,7 @@ public class FakeTeam {
 
     /**
      * Add the given player name to the team
+     *
      * @param playerName the player name to add
      */
     public void addMember(String playerName) {
@@ -83,6 +85,7 @@ public class FakeTeam {
 
     /**
      * Check if the given prefix and suffix is similar to the team prefix and suffix
+     *
      * @param prefix the prefix
      * @param suffix the suffix
      * @return if the given prefix and suffix are similar

core/src/main/java/zone/themcgamer/core/plugin/MGZPlugin.java

@@ -210,6 +210,7 @@ public abstract class MGZPlugin extends JavaPlugin {
 
     /**
      * Format the given memory into megabytes
+     *
      * @param memory the memory to format
      * @return the formatted memory
      */

core/src/main/java/zone/themcgamer/core/server/ServerManager.java

@@ -59,6 +59,7 @@ public class ServerManager extends Module {
 
     /**
      * Restart the given {@link MinecraftServer}
+     *
      * @param minecraftServer the server to restart
      */
     public void restart(MinecraftServer minecraftServer) {

core/src/main/java/zone/themcgamer/core/traveler/ServerTraveler.java

@@ -40,6 +40,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send all players to the provided server
+     *
      * @param server the server to send the players to
      */
     public void sendAll(String server) {
@@ -48,6 +49,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send all players to the provided server
+     *
      * @param server the server to send the players to
      * @param reason the reason for sending the players
      */
@@ -57,6 +59,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send all players to the provided server
+     *
      * @param server the server to send the players to
      * @param reason the reason for sending the players
      * @param inform whether or not to inform the player that they are
@@ -78,6 +81,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send the provided player to the provided server
+     *
      * @param player the player to send
      * @param server the name of the server to send the player to
      */
@@ -87,6 +91,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send the provided player to the provided server
+     *
      * @param player the player to send
      * @param server the name of the server to send the player to
      * @param inform whether or not to inform the player that they are
@@ -110,6 +115,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send the provided player to the provided {@link MinecraftServer}
+     *
      * @param player the player to send
      * @param server the server to send the player to
      */
@@ -119,6 +125,7 @@ public class ServerTraveler extends Module {
 
     /**
      * Send the provided player to the provided {@link MinecraftServer}
+     *
      * @param player the player to send
      * @param server the server to send the player to
      * @param inform whether or not to inform the player that they are

core/src/main/java/zone/themcgamer/core/twoFactor/TwoFactorAuthentication.java

@@ -242,7 +242,7 @@ public class TwoFactorAuthentication extends MiniAccount<TwoFactorClient> {
     }
 
     /**
-     * Check whetherr or not the provided {@link Player} is authenticating
+     * Check whether or not the provided {@link Player} is authenticating
      *
      * @param player the player to check
      * @return whether or not they're authenticating

core/src/main/java/zone/themcgamer/core/update/ServerUpdater.java

@@ -100,6 +100,7 @@ public class ServerUpdater extends Module {
 
     /**
      * Get a map of checksums from the given {@link File} directory
+     *
      * @param directory the directory
      * @return the map of checksums
      */
@@ -130,6 +131,7 @@ public class ServerUpdater extends Module {
 
     /**
      * Get the checksum for the given {@link File}
+     *
      * @param file the file to get the checksum for
      * @return the optional checksum
      */

proxy/src/main/java/zone/themcgamer/proxy/hub/HubBalancer.java

@@ -30,7 +30,7 @@ import java.util.concurrent.TimeUnit;
  */
 public class HubBalancer implements Runnable, Listener {
     private static final String NO_AVAILABLE_HUB = "&2&lMc&6&lGamer&c&lZone &8» &7There are no available lobbies found!";
-    private static final String HUB_SEND_FAILED = "&2&lMc&6&lGamer&c&lZone &8» &cAn error occured while sending you to a hub!";
+    private static final String HUB_SEND_FAILED = "&2&lMc&6&lGamer&c&lZone &8» &cAn error occurred while sending you to a hub!";
 
     private final Proxy proxy;
     private ServerGroupRepository serverGroupRepository;

servercontroller/src/main/java/zone/themcgamer/controller/ServerController.java

@@ -484,6 +484,7 @@ public class ServerController {
 
     /**
      * Generate a unique id based on the given values
+     *
      * @param includeCapitalLetters Whether or not to include capital letters in the unique id
      * @param includeLowercaseLetters Whether or not to include lowercase letters in the unique id
      * @return the unique id
@@ -506,6 +507,7 @@ public class ServerController {
 
     /**
      * Stop the given {@link MinecraftServer} with the given {@link StopCause}
+     *
      * @param server The Minecraft server to stop
      * @param cause The cause to stop the server
      */