Added JavaDocs Everywhere

Author: filliravaz

src/main/java/dev/le_app/mcss_api_java/Backup.java

@@ -19,6 +19,9 @@
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 
+/**
+ * This class contains information about a server's backup
+ */
 public class Backup {
 
     //BACKUP CLASS
@@ -919,6 +922,13 @@ private HttpURLConnection createPutConnection(URL url) throws IOException {
     }
 
 
+    /**
+     * Delete the backup - NOTE: This won't delete the backup files, just the backup information in MCSS
+     * @throws APIUnauthorizedException If the API key is invalid
+     * @throws APINotFoundException If the server or backup does not exist
+     * @throws APINoServerAccessException If the API key does not have access to the server
+     * @throws IOException If there is an error connecting to the API
+     */
     public void deleteBackup() throws APIUnauthorizedException, APINotFoundException, APINoServerAccessException, IOException {
         if (deleted) {
             throw new IllegalStateException("Backup has already been deleted");
@@ -947,6 +957,13 @@ public void deleteBackup() throws APIUnauthorizedException, APINotFoundException
         }
     }
 
+    /**
+     * Manually run a backup
+     * @throws APIUnauthorizedException If the API key is invalid
+     * @throws APINotFoundException If the server or backup does not exist
+     * @throws APINoServerAccessException If the API key does not have access to the server
+     * @throws IOException If there is an error connecting to the API
+     */
     public void runBackup() throws APIUnauthorizedException, APINotFoundException, APINoServerAccessException, IOException {
         if (deleted) {
             throw new IllegalStateException("Backup has already been deleted");

src/main/java/dev/le_app/mcss_api_java/BackupCompressionType.java

@@ -1,8 +1,20 @@
 package dev.le_app.mcss_api_java;
 
+/**
+ * The type of compression used for backups.
+ */
 public enum BackupCompressionType {
+    /**
+     * The backup is very compressed.
+     */
     HIGH(0),
+    /**
+     * The backup is compressed normally.
+     */
     LOW(1),
+    /**
+     * The backup is not compressed.
+     */
     NONE(2);
 
     private final int compressionType;
@@ -11,10 +23,19 @@ public enum BackupCompressionType {
         this.compressionType = compressionType;
     }
 
+    /**
+     * Gets associated valye for the compression type - Used for API requests.
+     * @return The compression type as INT.
+     */
     public int getValue() {
         return compressionType;
     }
 
+    /**
+     * Gets the compression type from the value.
+     * @param abbr The value to get the compression type from.
+     * @return The compression type.
+     */
     public static BackupCompressionType findByVal(int abbr){
         for(BackupCompressionType v : values()){
             if( v.getValue() == abbr ){

src/main/java/dev/le_app/mcss_api_java/BackupJob.java

@@ -12,13 +12,22 @@
 import java.net.URL;
 import java.util.ArrayList;
 
+/**
+ * Represents a backup job.
+ */
 public class BackupJob extends Job {
 
     private final MCSSApi api;
     private final String GUID;
     private final String TaskID;
 
 
+    /**
+     * Constructs a new BackupJob.
+     * @param api instance of MCSSApi
+     * @param GUID GUID of the backup job
+     * @param TaskID TaskID of the backup job
+     */
     public BackupJob(MCSSApi api, String GUID, String TaskID) {
         this.api = api;
         this.GUID = GUID;

src/main/java/dev/le_app/mcss_api_java/Endpoints.java

@@ -1,37 +1,61 @@
 package dev.le_app.mcss_api_java;
 
+/** List of endpoints for the API. */
 public enum Endpoints {
+    /** Root endpoint of the API */
     ROOT("https://{IP}/api/v1"),
+    /** Endpoint for getting server list */
     SERVERS("https://{IP}/api/v1/servers"),
+    /** Endpoint for getting server details */
     SERVER_DETAILS("https://{IP}/api/v1/servers/{SERVER_ID}"),
+    /** Endpoint for getting server count*/
     SERVER_COUNT("https://{IP}/api/v1/servers/count"),
+    /** Endpoint for getting server count with filter */
     SERVER_COUNT_FILTER("https://{IP}/api/v1/servers/count?filter={FILTER}"),
+    /** Endpoint for getting server list with filter and servertype */
     SERVER_COUNT_FILTER_SRVTYPE("https://{IP}/api/v1/servers/count?filter={FILTER}&serverTypeID={SRVTYPE}"),
+    /** Endpoint for executing a server action */
     EXECUTE_SERVER_ACTION("https://{IP}/api/v1/servers/{SERVER_ID}/execute/action"),
+    /** Endpoint for executing a server command */
     EXECUTE_SERVER_COMMAND("https://{IP}/api/v1/servers/{SERVER_ID}/execute/command"),
+    /** Endpoint for executing multiple commands */
     EXECUTE_SERVER_COMMANDS("https://{IP}/api/v1/servers/{SERVER_ID}/execute/commands"),
+    /** Endpoint for getting server backup list */
     SERVER_BACKUPS("https://{IP}/api/v1/servers/{SERVER_ID}/backups"),
+    /** Endpoint for getting server backup details */
     SERVER_BACKUP_DETAILS("https://{IP}/api/v1/servers/{SERVER_ID}/backups/{BACKUP_ID}"),
+    /** Endpoint for getting the server stats */
     GET_STATS("https://{IP}/api/v1/servers/{SERVER_ID}/stats"),
+    /** Endpoint for getting the server icon */
     GET_ICON("https://{IP}/api/v1/servers/{SERVER_ID}/icon"),
+    /** Endpoint for getting the server console */
     GET_CONSOLE("https://{IP}/api/v1/servers/{SERVER_ID}/console?AmountOfLines={AMOUNT_OF_LINES}"),
+    /** Endpoint for getting the server console from beginning */
     GET_CONSOLE_FROM_BEGINNING("https://{IP}/api/v1/servers/{SERVER_ID}/console?AmountOfLines={AMOUNT_OF_LINES}" +
             "&takeFromBeginning={BEGINNING}"),
+    /** Endpoint for getting the server console reversed */
     GET_CONSOLE_REVERSED("https://{IP}/api/v1/servers/{SERVER_ID}/console?AmountOfLines={AMOUNT_OF_LINES}" +
             "&reversed={REVERSED}"),
+    /** Endpoint for getting the server console from beginning reversed */
     GET_CONSOLE_FROM_BEGINNING_REVERSED("https://{IP}/api/v1/servers/{SERVER_ID}/console?AmountOfLines={AMOUNT_OF_LINES}" +
             "&takeFromBeginning={BEGINNING}&reversed={REVERSED}"),
 
+    /** Endpoint for checking if the console is outdated */
     IS_CONSOLE_OUTDATED("https://{IP}/api/v1/servers/{SERVER_ID}/console/outdated?lastLine={LAST_LINE}" +
             "&secondLastLine={SECOND_LAST_LINE}"),
 
+    /** Endpoint for getting the server scheduler */
     GET_SCHEDULER("https://{IP}/api/v1/servers/{SERVER_ID}/scheduler"),
 
+    /** Endpoint for getting the task amount filtered */
     GET_TASK_AMOUNT_FILTER("https://{IP}/api/v1/servers/{SERVER_ID}/scheduler/tasks/count?filter={FILTER}"),
 
+    /** Endpoint for getting the task list */
     GET_TASK_LIST("https://{IP}/api/v1/servers/{SERVER_ID}/scheduler/tasks"),
+    /** Endpoint for creating a task */
     CREATE_TASK("https://{IP}/api/v1/servers/{SERVER_ID}/scheduler/tasks"),
 
+    /** Endpoint for getting the task details */
     GET_TASK("https://{IP}/api/v1/servers/{SERVER_ID}/scheduler/tasks/{TASK_ID}");
 
 
@@ -41,6 +65,10 @@ public enum Endpoints {
         this.endpoint = endpoint;
     }
 
+    /**
+     * Returns the endpoint as string.
+     * @return The endpoint as string.
+     */
     public String getEndpoint() {
         return endpoint;
     }

src/main/java/dev/le_app/mcss_api_java/Errors.java

@@ -1,51 +1,86 @@
 package dev.le_app.mcss_api_java;
 
+/** List of possible errors of the API */
 public enum Errors {
 
     //General Purpose
+
+    /** Unauthorized */
     UNAUTHORIZED("API Token is invalid or expired. (ERR_401)"),
+    /** Not Found */
     NOT_FOUND("TaskID / ServerID / BackupID invalid. (ERR_404)"),
+    /** Version not supported */
     VERSION_MISMATCH("API version mismatch. Expected version: {VERSION}, got {GOT}"),
+    /** Error code was not recognized */
     NOT_RECOGNIZED("Error code not recognized. (ERR_UNKNOWN): "),
+    /** API doesn't have access to this server */
     NO_SERVER_ACCESS("You do not have access to this server. (ERR_403)"),
 
+    /** Filter error */
     ID_FILTER_ERROR("The serverTypeID is only required if the filter is set to FILTER"),
 
     //Tasks - Job Messages
+    /** Task details are invalid */
     INVALID_TASK_DETAILS("Task details are invalid. (ERR_409)"),
+    /** Task name contains special chars */
     NAME_SPECIAL_CHAR("Task name cannot contain special characters."),
 
+    /** Task is already deleted */
     TASK_ALREADY_DELETED("Task has already been deleted."),
+    /** Task has been deleted */
     TASK_DELETED("Cannot edit/execute a deleted task."),
+    /** Task Deleted - JOB */
     JOB_DELETED("Cannot get Job of a deleted task."),
+    /** Task Deleted - ENABLE */
     ENABLE_DELETED("Cannot enable a deleted task."),
+    /** Task Deleted - DISABLE */
     DISABLE_DELETED("Cannot disable a deleted task."),
+    /** Task Deleted - REPEAT */
     REPEAT_DELETED("Cannot repeat a deleted task."),
+    /** Task Deleted - RUN */
     RUN_DELETED("Cannot run a deleted task."),
+    /** Task Deleted - CHANGE NAME */
     CHANGE_NAME_DELETED("Cannot change name of a deleted task."),
+    /** Task Deleted - TIMING */
     INTERVAL_DELETED("Cannot get/set interval of a deleted task."),
+    /** Task Deleted - TIMING */
     TIME_DELETED("Cannot get/set time of a deleted task."),
 
+    /** Task doesn't have a valid job type */
     INVALID_JOB_TYPE("Task has invalid Job type."),
+    /** Task has no timing information */
     NO_TIMING_INFORMATION("Task has no timing information."),
+    /** Task time was invalid */
     COULD_NOT_PARSE_TIME("Could not parse time to LocalTime."),
 
+    /** Cannot repeat a timeless task */
     REPEAT_TIMELESS("Timeless tasks cannot be repeated."),
+    /** Cannot get time for a timeless task */
     TIME_TIMELESS("Timeless tasks don't have time details."),
+    /** Cannot get interval for a timeless task */
     INTERVAL_TIMELESS("Timeless tasks don't have an interval."),
+    /** Cannot enable a timeless task */
     ENABLE_TIMELESS("Timeless tasks cannot be enabled."),
+    /** Cannot disable a timeless task */
     DISABLE_TIMELESS("Timeless tasks cannot be disabled."),
 
+    /** Cannot get time of interval task */
     TIME_INTERVAL("Interval tasks don't have time details."),
+    /** Interval must be more than 0 */
     INTERVAL_GREATER_0("Interval must be greater than 0."),
 
+    /** Cannot get interval of time task */
     INTERVAL_FIXED_TIME("Fixed time tasks don't have an interval."),
 
+    /** No Commands found for task */
     COMMANDS_NOT_FOUND("No commands found for this task."),
+    /** No Commands given for task */
     COMMANDS_NOT_GIVEN("No commands were supplied for this task."),
 
+    /** Method not available for this job type */
     METHOD_NOT_SUPPORTED("This method is not supported for this job type."),
 
+    /** Task doesn't have an action */
     ACTION_NOT_FOUND("No action found for this task.");
 
     private final String message;
@@ -54,6 +89,10 @@ public enum Errors {
         this.message = message;
     }
 
+    /**
+     * Gets the message of the error.
+     * @return The message of the error.
+     */
     public String getMessage() {
         return message;
     }

src/main/java/dev/le_app/mcss_api_java/Info.java

@@ -1,6 +1,8 @@
 package dev.le_app.mcss_api_java;
 
-
+/**
+ * The information about the API.
+ */
 public class Info {
 
     private boolean isDev = false;
@@ -46,6 +48,9 @@ public String getUniqueID() {
         return UniqueID;
     }
 
+    /**
+     * @return the youAreAwesome
+     */
     public boolean getYouAreAwesome() {
         return youAreAwesome;
     }

src/main/java/dev/le_app/mcss_api_java/Job.java

@@ -7,18 +7,71 @@
 import java.io.IOException;
 import java.util.ArrayList;
 
+/**
+ * Represents a job.
+ */
 public abstract class Job {
 
+    /**
+     * Get the action of the task.
+     * @return The action of the task.
+     * @throws APIUnauthorizedException If the API key is not valid.
+     * @throws APINotFoundException If the server is not found.
+     * @throws IOException If there is an IO error (e.g. server is offline).
+     * @throws APIInvalidTaskDetailsException If the task details are invalid.
+     */
     public abstract ServerAction getAction() throws APIUnauthorizedException, APINotFoundException, IOException, APIInvalidTaskDetailsException;
 
+    /**
+     * Get the commands of the task.
+     * @return The commands of the task.
+     * @throws APIUnauthorizedException If the API key is not valid.
+     * @throws APINotFoundException If the server is not found.
+     * @throws IOException If there is an IO error (e.g. server is offline).
+     * @throws APIInvalidTaskDetailsException If the task details are invalid.
+     */
     public abstract ArrayList<String> getCommands() throws APIUnauthorizedException, APINotFoundException, IOException, APIInvalidTaskDetailsException;
 
+    /**
+     * Get the Backup ID of the backup executed by the task
+     * @return The Backup ID of the backup executed by the task
+     * @throws APIUnauthorizedException If the API key is not valid.
+     * @throws APINotFoundException If the server is not found.
+     * @throws IOException If there is an IO error (e.g. server is offline).
+     */
     public abstract String getBackupGUID() throws APIUnauthorizedException, APINotFoundException, IOException;
 
+    /**
+     * Set the new action to execute
+     * @param action The new action to execute
+     * @return this.Job (used for concatenating)
+     * @throws APIUnauthorizedException If the API key is not valid.
+     * @throws APINotFoundException If the server is not found.
+     * @throws APIInvalidTaskDetailsException If the task details are invalid.
+     * @throws IOException If there is an IO error (e.g. server is offline).
+     */
     public abstract Job setAction(ServerAction action) throws APIUnauthorizedException, APINotFoundException, APIInvalidTaskDetailsException, IOException;
 
+    /**
+     * Set the new commands to execute
+     * @param commands The new commands to execute
+     * @return this.Job (used for concatenating)
+     * @throws APIUnauthorizedException If the API key is not valid.
+     * @throws APINotFoundException If the server is not found.
+     * @throws APIInvalidTaskDetailsException If the task details are invalid.
+     * @throws IOException If there is an IO error (e.g. server is offline).
+     */
     public abstract Job setCommands(String... commands) throws APIUnauthorizedException, APINotFoundException, APIInvalidTaskDetailsException, IOException;
 
+    /**
+     * Set the new backup to execute
+     * @param backupGUID The new backup to execute
+     * @return this.Job (used for concatenating)
+     * @throws APIUnauthorizedException If the API key is not valid.
+     * @throws APINotFoundException If the server is not found.
+     * @throws APIInvalidTaskDetailsException If the task details are invalid.
+     * @throws IOException If there is an IO error (e.g. server is offline).
+     */
     public abstract Job setBackupGUID(String backupGUID) throws APIUnauthorizedException, APINotFoundException, IOException, APIInvalidTaskDetailsException;
 
 

src/main/java/dev/le_app/mcss_api_java/KeepOnline.java

@@ -1,9 +1,15 @@
 package dev.le_app.mcss_api_java;
 
+/**
+ * The keep online behaviour of a server
+ */
 public enum KeepOnline {
 
+    /** Server can shutdown / crash */
     NONE(0),
+    /** Server will be restarted if it crashes */
     ELEVATED(1),
+    /** Server will be restarted if it crashes or is shutdown */
     AGGRESSIVE(2);
 
     private final int value;
@@ -12,8 +18,17 @@ public enum KeepOnline {
         value = newValue;
     }
 
+    /**
+     * Gets associated value for the keep online behaviour - Used for API requests.
+     * @return The keep online behaviour as INT.
+     */
     public int getValue() { return value; }
 
+    /**
+     * Gets the keep online behaviour from the value.
+     * @param abbr The value to get the keep online behaviour from.
+     * @return The keep online behaviour.
+     */
     public static KeepOnline findByVal(int abbr){
         for(KeepOnline v : values()){
             if( v.getValue() == abbr ){