Add documentation for main branch

Author: 1whatleytay

src/main/java/org/hydev/mcpm/client/arguments/ControllerFactory.java

@@ -15,6 +15,12 @@
 import org.hydev.mcpm.client.commands.controllers.UpdateController;
 import org.hydev.mcpm.client.local.PageController;
 
+/**
+ * Handles the creation of default factory classes.
+ * The required parameters to initialize these classes are acquired from the `boundary` object.
+ *
+ * @param boundary A provider to acquire the required interactors to initialize the controllers.
+ */
 public record ControllerFactory(InteractorFactoryBoundary boundary) implements ControllerFactoryBoundary {
     @Override
     public PageBoundary pageBoundary() {

src/main/java/org/hydev/mcpm/client/arguments/ControllerFactoryBoundary.java

@@ -14,20 +14,105 @@
 import org.hydev.mcpm.client.commands.controllers.UnloadController;
 import org.hydev.mcpm.client.commands.controllers.UpdateController;
 
+/**
+ * Abstract factory for creating controller classes.
+ * Classes can implement this in order to provide their own ways of initializing Controllers.
+ * <p>
+ * The methods of this class should be cached
+ * (e.g. you should be able to invoke them many times and get the same object).
+ */
 public interface ControllerFactoryBoundary {
-    // PageBoundary/PageController technically acts as a controller in this case.
-    // And is used for instantiation of other Controller classes.
+    /**
+     * Creates a page boundary object that handles pagination and persisting of pages (for the `page` command).
+     * <p>
+     * PageBoundary/PageController technically acts as a controller in this case.
+     * And is used for instantiation of other Controller classes.
+     *
+     * @return A PageBoundary object.
+     */
     PageBoundary pageBoundary();
+
+    /**
+     * Creates an export controller that interfaces with ExportPluginsBoundary.
+     *
+     * @return A ExportPluginsController object.
+     */
     ExportPluginsController exportController();
+
+    /**
+     * Creates a list controller that interfaces with ListAllBoundary.
+     *
+     * @return A ListController object.
+     */
     ListController listController();
+
+    /**
+     * Creates a search controller that interfaces with SearchPackagesBoundary.
+     *
+     * @return A SearchPackagesController object.
+     */
     SearchPackagesController searchController();
+
+    /**
+     * Creates a mirror controller that interfaces with MirrorSelectorBoundary.
+     *
+     * @return A MirrorController object.
+     */
     MirrorController mirrorController();
+
+    /**
+     * Creates an info controller that presents the user installed plugin info.
+     *
+     * @return A InfoController object.
+     */
     InfoController infoController();
+
+    /**
+     * Creates a mirror controller that interfaces with InstallBoundary.
+     *
+     * @return A InstallController object.
+     */
     InstallController installController();
+
+    /**
+     * Creates an `uninstall` controller that interfaces with UninstallBoundary.
+     *
+     * @return A UninstallController object.
+     */
     UninstallController uninstallController();
+
+    /**
+     * Creates an update controller that interfaces with UpdateBoundary.
+     *
+     * @return A UpdateController object.
+     */
     UpdateController updateController();
+
+    /**
+     * Creates a refresh controller that fetches the database in case it gets out of date.
+     *
+     * @return A RefreshController object.
+     */
     RefreshController refreshController();
+
+    /**
+     * Creates a load controller that interfaces with LoadBoundary.
+     *
+     * @return A LoadController object.
+     */
     LoadController loadController();
+
+    /**
+     * Creates a reload controller that interfaces with ReloadBoundary.
+     *
+     * @return A ReloadController object.
+     */
     ReloadController reloadController();
+
+    /**
+     * Creates an unload controller that interfaces with UnloadBoundary.
+     *
+     * @return A UnloadController object.
+     */
     UnloadController unloadController();
 }

src/main/java/org/hydev/mcpm/client/arguments/InteractorFactory.java

@@ -40,6 +40,10 @@
 import java.util.Map;
 import java.util.function.Supplier;
 
+/**
+ * Default factory for interactor.
+ * This handles caching the various objects used for interactors, and is on the highest level of CA.
+ */
 public class InteractorFactory implements InteractorFactoryBoundary {
     // Lazy solution, not going to store variables.
     private final Map<Class<?>, Object> localCache = new HashMap<>();
@@ -49,6 +53,15 @@ public InteractorFactory(boolean server) {
         this.server = server;
     }
 
+    /**
+     * Returns an object of type `type` that it previously returned with an identical `type`.
+     * Otherwise, it invokes `create` and returns the value of that.
+     *
+     * @param type The type of the object to cache.
+     * @param create A creation method if this object is not already cached.
+     * @param <T> The type of the cached object.
+     * @return An object of type T.
+     */
     private <T> T cache(Class<T> type, Supplier<T> create) {
         var value = localCache.getOrDefault(type, null);
 

src/main/java/org/hydev/mcpm/client/arguments/InteractorFactoryBoundary.java

@@ -18,22 +18,133 @@
 import org.hydev.mcpm.client.updater.CheckForUpdatesBoundary;
 import org.hydev.mcpm.client.updater.UpdateBoundary;
 
+/**
+ * Abstract factory for creating interactor classes.
+ * Classes can implement this in order to provide their implementations of these boundary classes.
+ * <p>
+ * The methods of this class should be cached
+ * (e.g. you should be able to invoke them many times and get the same object).
+ * <p>
+ * This class has the ability of creating a bunch of different boundaries.
+ *
+ */
 public interface InteractorFactoryBoundary {
+    /**
+     * Creates a mirror boundary for managing currently selected and available mirrors.
+     *
+     * @return A MirrorSelectBoundary object.
+     */
     MirrorSelectBoundary mirrorSelector();
+
+    /**
+     * Creates a database fetcher for grabbing a list of all available plugins.
+     *
+     * @return A DatabaseFetcher object.
+     */
     DatabaseFetcher databaseFetcher();
+
+    /**
+     * Creates a plugin tracker object for keeping track of currently installed plugins.
+     *
+     * @return A PluginTracker object.
+     */
     PluginTracker pluginTracker();
+
+    /**
+     * Creates a load boundary object for hot loading new plugins.
+     *
+     * @return A LoadBoundary object.
+     */
     LoadBoundary loadBoundary();
+
+    /**
+     * Creates a load boundary object for hot reloading already running plugins.
+     *
+     * @return A ReloadBoundary object.
+     */
     ReloadBoundary reloadBoundary();
+
+    /**
+     * Creates an unload boundary object for hot unloading running plugins.
+     *
+     * @return A UnloadBoundary object.
+     */
     UnloadBoundary unloadBoundary();
+
+    /**
+     * Creates a jar boundary object for looking up plugins by name.
+     *
+     * @return A LocalJarBoundary object.
+     */
     LocalJarBoundary jarBoundary();
+
+    /**
+     * Creates a fetcher listener object for sending database fetching updates to the user.
+     *
+     * @return A DatabaseFetcherListener object.
+     */
     DatabaseFetcherListener fetcherListener();
+
+    /**
+     * Creates a search boundary object for looking up plugins in the database.
+     *
+     * @return A SearchPackagesBoundary object.
+     */
     SearchPackagesBoundary searchBoundary();
+
+    /**
+     * Creates a plugin downloader object for downloading plugins to the filesystem.
+     *
+     * @return A PluginDownloader object.
+     */
     PluginDownloader pluginDownloader();
+
+    /**
+     * Creates an `install` boundary object for installing new plugins.
+     *
+     * @return A InstallBoundary object.
+     */
     InstallBoundary installBoundary();
+
+    /**
+     * Creates an `match` boundary object for finding plugins by id.
+     *
+     * @return A MatchPluginsBoundary object.
+     */
     MatchPluginsBoundary matchBoundary();
+
+    /**
+     * Creates an `check for updates` boundary object for checking if plugins have available updates.
+     *
+     * @return A CheckForUpdatesBoundary object.
+     */
     CheckForUpdatesBoundary checkForUpdatesBoundary();
+
+    /**
+     * Creates an `update` boundary object for updating installed plugins.
+     *
+     * @return A UpdateBoundary object.
+     */
     UpdateBoundary updateBoundary();
+
+    /**
+     * Creates an `export` boundary object for exporting a list of installed plugins.
+     *
+     * @return A ExportPluginsBoundary object.
+     */
     ExportPluginsBoundary exportBoundary();
+
+    /**
+     * Creates an `list` boundary object for listing installed plugins.
+     *
+     * @return A ListAllBoundary object.
+     */
     ListAllBoundary listBoundary();
+
+    /**
+     * Creates an `uninstall` boundary object for uninstalling plugins.
+     *
+     * @return A UninstallBoundary object.
+     */
     UninstallBoundary uninstallBoundary();
 }

src/main/java/org/hydev/mcpm/client/arguments/ParserFactory.java

@@ -18,6 +18,10 @@
 import java.util.List;
 import java.util.stream.Stream;
 
+/**
+ * Handles the creation of CommandParser list.
+ * This is a simple factory that just invokes the methods of ControllerFactoryBoundary and returns a list of parsers.
+ */
 public class ParserFactory {
     private ParserFactory() { }
 

src/main/java/org/hydev/mcpm/client/commands/controllers/ExportPluginsController.java

@@ -24,7 +24,8 @@ public ExportPluginsController(ExportPluginsBoundary boundary) {
     /**
      * Call the boundary to perform an export.
      *
-     * @param input Input specifying the export parameters
+     * @param stream Input specifying the export parameters
+     * @param cache Whether to use the cached version of the database.
      * @param log where to log the operation
      */
     public void export(OutputStream stream, boolean cache, Consumer<String> log) {

src/main/java/org/hydev/mcpm/client/list/ListAllInteractor.java

@@ -9,7 +9,10 @@
 /**
  * Implementation to the ListAll functionality
  */
-public record ListAllInteractor(PluginTracker pluginTracker, CheckForUpdatesBoundary updates) implements ListAllBoundary {
+public record ListAllInteractor(
+    PluginTracker pluginTracker,
+    CheckForUpdatesBoundary updates
+) implements ListAllBoundary {
     /**
      * listAllInteractor interacts with the LocalPluginTracker to get the list of
      * plugins, according to a specified
@@ -25,24 +28,25 @@ public record ListAllInteractor(PluginTracker pluginTracker, CheckForUpdatesBoun
     public List<PluginYml> listAll(ListType parameter) {
         var installed = pluginTracker.listInstalled();
         switch (parameter) {
-            case ALL:
+            case ALL -> {
                 return installed;
-
-            case MANUAL:
+            }
+            case MANUAL -> {
                 var local = pluginTracker.listManuallyInstalled();
                 return installed.stream().filter(it -> local.contains(it.name())).toList();
-
-            case AUTOMATIC:
+            }
+            case AUTOMATIC -> {
                 var manual = pluginTracker.listManuallyInstalled();
                 return installed.stream().filter(it -> !manual.contains(it.name())).toList();
-
-            case OUTDATED:
+            }
+            case OUTDATED -> {
                 ListUpdateableBoundary listUpdateableBoundary = new ListUpdateableHelper();
                 var outdated = listUpdateableBoundary.listUpdateable(pluginTracker, updates);
                 return installed.stream().filter(it -> outdated.contains(it.name())).toList();
-
-            default:
+            }
+            default -> {
                 return null;
+            }
         }
     }
 }