Merge pull request #12 from anas-elgarhy/add-docs

Add the java docs and improve the code

Author: 0x61nas

src/main/java/com/anas/jdosattacker/FieldException.java

@@ -1,7 +1,10 @@
 package com.anas.jdosattacker;
 
+/**
+ * `FieldException` is a custom exception class that is thrown when a field value is wrong.
+ */
 public class FieldException extends Exception {
-    public FieldException(String message) {
+    public FieldException(final String message) {
         super(message);
     }
 }

src/main/java/com/anas/jdosattacker/Main.java

@@ -1,7 +1,10 @@
 package com.anas.jdosattacker;
 
+/**
+ * Entry point of the program.
+ */
 public class Main {
-    public static void main(String[] args) {
+    public static void main(final String[] args) {
         new MainController(args); // Just it :D
     }
 }

src/main/java/com/anas/jdosattacker/MainController.java

@@ -7,17 +7,27 @@
 import java.io.IOException;
 import java.util.ArrayList;
 
+/**
+ * It's a controller class that creates threads and starts them
+ */
 public class MainController {
-    public static final String version = "1.2.0";
+    public static final String VERSION = "1.2.0";
     private static int threadsNumber = 0;
     private final ArrayList<Thread> threads;
 
-    public MainController(String[] args) {
+    /**
+     * The constructor.
+     * @param args The arguments passed to the program
+     */
+    public MainController(final String[] args) {
+        // It's processing arguments from command line.
         new ArgumentsProcessor().process(args);
+        // It's checking if there are important empty fields in the request.
         if (this.hasEmptyFields()) {
             try {
+                // If true, start the tui and get the data from the user.
                 new GetData();
-            } catch (IOException e) {
+            } catch (final IOException e) {
                 System.err.println("Error: " + e.getMessage());
                 System.exit(1);
             }
@@ -27,35 +37,57 @@ public MainController(String[] args) {
         startThreads();
     }
 
+    /**
+     * Start all the threads in the threads array.
+     */
     private void startThreads() {
         for (Thread thread : threads) {
             thread.start();
         }
     }
 
-    public static void setThreadsNum(int threadsNum) throws FieldException {
+    /**
+     * Set the number of threads to use.
+     *
+     * @param threadsNum number of threads.
+     * @throws FieldException if the number of threads is less than 1.
+     */
+    public static void setThreadsNum(final int threadsNum) throws FieldException {
         if (threadsNum < 1) {
             throw new FieldException("Number of threads must be greater than 0");
         }
         threadsNumber = threadsNum;
     }
 
-    public static void setThreadsNum(String threadsNumber) throws FieldException {
+    /**
+     * Set the threads number from string.
+     * @param threadsNumber string number of threads.
+     * @throws FieldException if the number of threads is less than 1, or if it's not an integer number.
+     */
+    public static void setThreadsNum(final String threadsNumber) throws FieldException {
         try {
-            int threadsNum = Integer.parseInt(threadsNumber);
+            final var threadsNum = Integer.parseInt(threadsNumber);
             MainController.setThreadsNum(threadsNum);
         } catch (NumberFormatException e) {
-            throw new FieldException("Number of threads must be a number");
+            throw new FieldException("Number of threads must be an integer number");
         }
     }
 
+    /**
+     * It creates a new threads and set there names and add them to the threads array.
+     */
     public void createThreads() {
-        for (int i = 0; i < threadsNumber; i++) {
+        for (var i = 0; i < threadsNumber; i++) {
             threads.add(new Thread(new Requester()));
            threads.get(i).setName("Requester " + (i + 1));
         }
     }
 
+    /**
+     * If the requester has empty fields or the number of threads is 0, then return true.
+     *
+     * @return A boolean value, representing if the requester has empty fields or the number of threads is 0.
+     */
     public boolean hasEmptyFields() {
         return Requester.hasRequirementEmptyFields() || threadsNumber == 0;
     }

src/main/java/com/anas/jdosattacker/args/ArgumentsProcessor.java

@@ -1,18 +1,28 @@
 package com.anas.jdosattacker.args;
 
+import com.anas.jdosattacker.FieldException;
 import com.anas.jdosattacker.MainController;
 import com.anas.jdosattacker.request.Requester;
 import org.apache.commons.cli.*;
 
+/**
+ * It parses the command line arguments and sets the corresponding variables, and if there are any errors, it prints the
+ * help and exits
+ */
 public class ArgumentsProcessor {
-    private Options options;
-    private CommandLineParser parser;
+    private final Options options;
 
+    /**
+     * The constructor.
+     */
     public ArgumentsProcessor() {
-        initialize();
+        options = new Options();
         setupOptions();
     }
 
+    /**
+     * Set up the command line options.
+     */
     private void setupOptions() {
         options.addOption("h", "help", false, "Print this help");
         options.addOption("v", "version", false, "Print version");
@@ -24,45 +34,58 @@ private void setupOptions() {
         options.addOption("connectTimeout", true, "Connection timeout (default: 5000)");
     }
 
-    private void initialize() {
-        options = new Options();
-        parser = new DefaultParser();
-    }
 
-    public void process(String[] args) {
+    /**
+     * It parses the command line arguments and sets the corresponding variables,
+     * and if there are any errors, it prints the help and exits.
+     * and if the arguments have a help or version flag, it prints the info and exits.
+     *
+     * @param args the command line arguments
+     */
+    public void process(final String[] args) {
         try {
-            CommandLine commandLine = parser.parse(options, args);
+            final var commandLine = new DefaultParser().parse(options, args);
             if (commandLine.hasOption("help")) {
-                printHelp();
+                printHelp(0);
             } else if (commandLine.hasOption("version")) {
                 printVersion();
-            } else if (commandLine.hasOption("url"))
-                Requester.setUrl(commandLine.getOptionValue("url"));
+            }
 
+            if (commandLine.hasOption("url"))
+                Requester.setUrl(commandLine.getOptionValue("url"));
             if (commandLine.hasOption("threads"))
-                MainController.setThreadsNum(Integer.parseInt(commandLine.getOptionValue("threads")));
+                MainController.setThreadsNum(commandLine.getOptionValue("threads"));
             if (commandLine.hasOption("number"))
-                Requester.setReqNumber(Integer.parseInt(commandLine.getOptionValue("number")));
+                Requester.setReqNumber(commandLine.getOptionValue("number"));
             if (commandLine.hasOption("connectTimeout"))
-                Requester.setConnectTimeout(Integer.parseInt(commandLine.getOptionValue("connectTimeout")));
+                Requester.setConnectTimeout(commandLine.getOptionValue("connectTimeout"));
             if (commandLine.hasOption("useragent"))
                 Requester.setUserAgent(commandLine.getOptionValue("useragent"));
             if (commandLine.hasOption("requestMethod"))
                 Requester.setRequestMethod(commandLine.getOptionValue("requestMethod"));
 
-        } catch (Exception e) {
+        } catch (final ParseException | FieldException e) {
+            // If an error occurs, print the error message and a help message and exit.
             System.err.println("Error: " + e.getMessage());
-            printHelp();
-            System.exit(1);
+            printHelp(1);
         }
     }
 
+    /**
+     * If the user types in the command line argument -v, this method will be called.
+     */
     private void printVersion() {
-        System.out.println("Version: " + MainController.version);
+        System.out.println("Version: " + MainController.VERSION);
         System.exit(0);
     }
 
-    private void printHelp() {
-        new HelpFormatter().printHelp("java -jar jdosattacker.jar -u <URL>", options);
+    /**
+     * Prints the help message and exits the program.
+     *
+     * @param exitCode The exit code to use when exiting the application.
+     */
+    private void printHelp(final int exitCode) {
+        new HelpFormatter().printHelp("java -jar jdosattacker.jar [options]", options);
+        System.exit(exitCode);
     }
 }