Added @SInCE for JavaDocs

Author: lewmilburn

pom.xml

@@ -49,7 +49,11 @@
                     <relocations>
                         <relocation>
                             <pattern>org.bstats</pattern>
-                            <shadedPattern>net.lewmc.foundry</shadedPattern>
+                            <shadedPattern>net.lewmc.foundry.external</shadedPattern>
+                        </relocation>
+                        <relocation>
+                            <pattern>io.papermc</pattern>
+                            <shadedPattern>net.lewmc.foundry.external</shadedPattern>
                         </relocation>
                     </relocations>
                 </configuration>
@@ -85,6 +89,12 @@
             <version>1.21.8-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>io.papermc</groupId>
+            <artifactId>paperlib</artifactId>
+            <version>1.0.7</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <distributionManagement>

src/main/java/net/lewmc/foundry/Files.java

@@ -26,6 +26,7 @@ public class Files {
     /**
      * The constructor for the Files class.
      * @param plugin Reference to the main plugin class.
+     * @since 1.0.0
      */
     public Files(FoundryConfig config, JavaPlugin plugin) {
         this.plugin = plugin;
@@ -38,6 +39,7 @@ public Files(FoundryConfig config, JavaPlugin plugin) {
      * Creates a file.
      * @param path String - Path to the file.
      * @return boolean - If the file and directories (if required) were created successfully.
+     * @since 1.0.0
      */
     public boolean create(String path) {
         File createFile = new File(this.plugin.getDataFolder(), this.parseFileName(path));
@@ -63,6 +65,7 @@ public boolean create(String path) {
      * Checks if a file exists.
      * @param path - Path to the file.
      * @return boolean - If the file exists
+     * @since 1.0.0
      */
     public boolean exists(String path) {
         File file = new File(this.plugin.getDataFolder(), this.parseFileName(path));
@@ -73,6 +76,7 @@ public boolean exists(String path) {
      * Opens a configuration file.
      * @param path String - Path to the file
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean load(String path) {
         if (!this.isOpen()) {
@@ -105,6 +109,7 @@ public boolean load(String path) {
      * Opens a configuration file from root (without checking format).
      * @param path String - Path to the file
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean loadNoReformat(String path) {
         if (!this.isOpen()) {
@@ -137,6 +142,7 @@ public boolean loadNoReformat(String path) {
      * Opens a configuration file from root (without checking format).
      * @param file File - Instance of the file.
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean loadNoReformat(File file) {
         if (!this.isOpen()) {
@@ -168,6 +174,7 @@ public boolean loadNoReformat(File file) {
      * Deletes a file.
      * @param path String - The path of the file
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean delete(String path) {
         try {
@@ -184,6 +191,7 @@ public boolean delete(String path) {
      * Saves and closes the current configuration file to a custom location.
      * @param file String - The file.
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean save(File file) {
         if (this.isOpen()) {
@@ -205,6 +213,7 @@ public boolean save(File file) {
     /**
      * Saves and closes the current configuration file.
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean save() {
         if (this.isOpen()) {
@@ -232,6 +241,7 @@ public boolean save() {
      * @param key The location of the value.
      * @param value The value to set.
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean set(String key, Object value) {
         if (this.isOpen()) {
@@ -250,6 +260,7 @@ public boolean set(String key, Object value) {
      * Gets an object from the configuration file.
      * @param key The location of the value.
      * @return Object - the value.
+     * @since 1.0.0
      */
     public Object get(String key) {
         if (this.isOpen()) {
@@ -264,6 +275,7 @@ public Object get(String key) {
      * Gets a boolean from the configuration file.
      * @param key The location of the value.
      * @return boolean - the value.
+     * @since 1.0.0
      */
     public boolean getBoolean(String key) {
         if (this.isOpen()) {
@@ -278,6 +290,7 @@ public boolean getBoolean(String key) {
      * Gets a string from the configuration file.
      * @param key The location of the value.
      * @return String - the value.
+     * @since 1.0.0
      */
     public String getString(String key) {
         if (this.isOpen()) {
@@ -292,6 +305,7 @@ public String getString(String key) {
      * Gets an integer from the configuration file.
      * @param key The location of the value.
      * @return int - the value.
+     * @since 1.0.0
      */
     public int getInt(String key) {
         if (this.isOpen()) {
@@ -306,6 +320,7 @@ public int getInt(String key) {
      * Gets a double from the configuration file.
      * @param key The location of the value.
      * @return double - the value.
+     * @since 1.0.0
      */
     public double getDouble(String key) {
         if (this.isOpen()) {
@@ -320,6 +335,7 @@ public double getDouble(String key) {
      * Gets a String List from the configuration file.
      * @param key The location of the value.
      * @return List - the value.
+     * @since 1.0.0
      */
     public List<String> getStringList(String key) {
         if (this.isOpen()) {
@@ -334,6 +350,7 @@ public List<String> getStringList(String key) {
      * Gets a List from the configuration file if is root.
      * @param deep Should do deep search?
      * @return List - the value.
+     * @since 1.0.0
      */
     public Set<String> getKeys(boolean deep) {
         if (this.isOpen()) {
@@ -349,6 +366,7 @@ public Set<String> getKeys(boolean deep) {
      * @param section The section of the file.
      * @param deep Should do deep search?
      * @return List - the value.
+     * @since 1.0.0
      */
     public Set<String> getKeys(String section, boolean deep) {
         if (this.isOpen()) {
@@ -368,6 +386,7 @@ public Set<String> getKeys(String section, boolean deep) {
      * Closes the configuration file without saving it.
      * Not needed if save() has been used.
      * @return boolean - If the operation was successful
+     * @since 1.0.0
      */
     public boolean close() {
         if (this.isOpen()) {
@@ -383,6 +402,7 @@ public boolean close() {
     /**
      * Checks if a file is open.
      * @return boolean - If a file is open
+     * @since 1.0.0
      */
     public boolean isOpen() {
         return this.config != null && this.file != null;
@@ -392,6 +412,7 @@ public boolean isOpen() {
      * Return the location of the player's data file from an instance of the player.
      * @param player Player - The player.
      * @return The data file URI inside the /plugin/essence folder.
+     * @since 1.0.0
      */
     public String playerDataFile(Player player) {
         return "data/players/"+player.getUniqueId()+".yml";
@@ -401,6 +422,7 @@ public String playerDataFile(Player player) {
      * Return the location of the player's data file from an instance of the player.
      * @param offlinePlayer OfflinePlayer - The player.
      * @return The data file URI inside the /plugin/essence folder.
+     * @since 1.0.0
      */
     public String playerDataFile(OfflinePlayer offlinePlayer) {
         return "data/players/"+offlinePlayer.getUniqueId()+".yml";
@@ -410,6 +432,7 @@ public String playerDataFile(OfflinePlayer offlinePlayer) {
      * Return the location of the player's data file from the player's UUID.
      * @param uuid UUID - The player's UUID.
      * @return The data file URI inside the /plugin/essence folder.
+     * @since 1.0.0
      */
     public String playerDataFile(UUID uuid) {
         return "data/players/"+uuid+".yml";
@@ -419,6 +442,7 @@ public String playerDataFile(UUID uuid) {
      * Parses the filename to ensure leading slashes are correct.
      * @param fileName String - The name of the file to be opened.
      * @return The correctly parsed filename.
+     * @since 1.0.0
      */
     private String parseFileName(String fileName) {
         if (fileName != null) {
@@ -437,6 +461,7 @@ private String parseFileName(String fileName) {
      * Removes a key and it's associated data.
      * @param key String - The item to remove.
      * @return If the operation was successful
+     * @since 1.0.0
      */
     public boolean remove(String key) {
         if (this.isOpen()) {

src/main/java/net/lewmc/foundry/Foundry.java

@@ -9,6 +9,7 @@ public class Foundry extends JavaPlugin {
 
     /**
      * This function runs when Foundry is enabled.
+     * @since 1.0.0
      */
     @Override
     public void onEnable() {

src/main/java/net/lewmc/foundry/FoundryConfig.java

@@ -24,6 +24,7 @@ public class FoundryConfig {
     /**
      * Sets up the FoundryConfig class.
      * @param plugin Plugin - The parent plugin.
+     * @since 1.0.0
      */
     public FoundryConfig(JavaPlugin plugin) {
         this.plugin = plugin;
@@ -33,6 +34,7 @@ public FoundryConfig(JavaPlugin plugin) {
     /**
      * Sets if Foundry should be verbose.
      * @param verbose boolean - true/false
+     * @since 1.0.0
      */
     public void setVerbose(boolean verbose) {
         this.verbose = verbose;
@@ -41,6 +43,7 @@ public void setVerbose(boolean verbose) {
     /**
      * Overwrites Foundry's preset Plugin ID.
      * @param pluginId String - Plugin ID
+     * @since 1.0.0
      */
     public void setPluginId(String pluginId) {
         this.pluginId = pluginId.toLowerCase();

src/main/java/net/lewmc/foundry/FoundryModule.java

@@ -21,6 +21,7 @@ abstract public class FoundryModule {
      * Executes all other functions.
      * @param plugin    Reference to the main plugin class.
      * @param reg       The Foundry Registry.
+     * @since 1.0.0
      */
     public FoundryModule(@NotNull JavaPlugin plugin, @NotNull Registry reg) {
         this.plugin = plugin;
@@ -33,16 +34,19 @@ public FoundryModule(@NotNull JavaPlugin plugin, @NotNull Registry reg) {
 
     /**
      * Where commands to be registered should be placed.
+     * @since 1.0.0
      */
     public abstract void registerCommands();
 
     /**
      * Where events to be registered should be placed.
+     * @since 1.0.0
      */
     public abstract void registerEvents();
 
     /**
      * Where tab completers to be registered should be placed.
+     * @since 1.0.0
      */
     public abstract void registerTabCompleters();
 }

src/main/java/net/lewmc/foundry/IBukkit.java

@@ -28,6 +28,7 @@ public class IBukkit {
      * Constructor for the class.
      * @param config FoundryConfig - Foundry's configuration.
      * @param plugin Plugin - Reference to the main plugin class.
+     * @since 1.2.0
      */
     public IBukkit(FoundryConfig config, JavaPlugin plugin) {
         this.config = config;
@@ -37,6 +38,7 @@ public IBukkit(FoundryConfig config, JavaPlugin plugin) {
     /**
      * Fetches the Bukkit Command Map
      * @return CommandMap on success, null on fail.
+     * @since 1.2.0
      */
     public CommandMap getCommandMap() {
        try {
@@ -61,6 +63,7 @@ public CommandMap getCommandMap() {
      * @see Registry#runtimeCommand(String, CommandExecutor, String...)
      * @param name The command's name.
      * @return PluginCommand the constructed command.
+     * @since 1.2.0
      */
     public PluginCommand constructRuntimeCommand(String name) {
         PluginCommand command = null;
@@ -82,6 +85,7 @@ public PluginCommand constructRuntimeCommand(String name) {
     /**
      * Fetches the Bukkit Plugin Manager
      * @return PluginManager on success, null on fail.
+     * @since 1.2.0
      */
     public PluginManager getPluginManager() {
        try {

src/main/java/net/lewmc/foundry/Logger.java

@@ -11,6 +11,7 @@ public class Logger {
     /**
      * Constructor for the LogUtil class.
      * @param config - Reference to the config class.
+     * @since 1.0.0
      */
     public Logger(FoundryConfig config) {
         this.config = config;
@@ -19,6 +20,7 @@ public Logger(FoundryConfig config) {
     /**
      * Logs a message to the server console as informational (standard).
      * @param message String - Message to log.
+     * @since 1.0.0
      */
     public void info(String message) {
         Bukkit.getLogger().info("[" + this.config.pluginId.toUpperCase() + "] " + message);
@@ -27,6 +29,7 @@ public void info(String message) {
     /**
      * Logs a message to the server console as warning (non-fatal error).
      * @param message String - Message to log.
+     * @since 1.0.0
      */
     public void warn(String message) {
         Bukkit.getLogger().warning("[" + this.config.pluginId.toUpperCase() + "] " + message);
@@ -35,13 +38,15 @@ public void warn(String message) {
     /**
      * Logs a message to the server console as severe (fatal error).
      * @param message String - Message to log.
+     * @since 1.0.0
      */
     public void severe(String message) {
         Bukkit.getLogger().severe("[" + this.config.pluginId.toUpperCase() + "] " + message);
     }
 
     /**
      * Logs a message to the console, informing the console operator that it cannot run the command requested.
+     * @since 1.0.0
      */
     public boolean noConsole() {
         this.warn("Sorry, you need to be an in-game player to use this command.");

src/main/java/net/lewmc/foundry/Permissions.java

@@ -13,6 +13,7 @@ public class Permissions {
     /**
      * Constructor.
      * @param cs CommandSender - The user who executed the command.
+     * @since 1.0.0
      */
     public Permissions(CommandSender cs) {
         this.cs = cs;
@@ -22,6 +23,7 @@ public Permissions(CommandSender cs) {
      * Checks if the user has a specific permission.
      * @param node String - the permission node to check.
      * @return boolean - If the user has a permission (true/false)
+     * @since 1.0.0
      */
     public boolean has(String node) {
         if (this.cs instanceof Player p) {
@@ -34,6 +36,7 @@ public boolean has(String node) {
     /**
      * Checks if the user has a specific permission.
      * @return boolean - If the user is operator (true/false)
+     * @since 1.0.0
      */
     public boolean isOp() {
         if (this.cs instanceof Player p) {