Add javadoc to mock boundary classes

Author: 1whatleytay

src/test/java/org/hydev/mcpm/client/arguments/mock/MockExportBoundary.java

@@ -7,6 +7,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the ExportPluginsBoundary interface for testing.
+ */
 public class MockExportBoundary implements ExportPluginsBoundary {
     private final List<ExportPluginsInput> inputs = new ArrayList<>();
 
@@ -19,10 +22,20 @@ public ExportPluginsResult export(ExportPluginsInput input) {
         return new ExportPluginsResult(defaultResult);
     }
 
+    /**
+     * Sets the default result that this interface will return when invoked.
+     *
+     * @param defaultResult The default return value for the export method.
+     */
     public void setDefaultResult(ExportPluginsResult.State defaultResult) {
         this.defaultResult = defaultResult;
     }
 
+    /**
+     * Gets a list of all inputs that this interface was invoked with.
+     *
+     * @return A list of input objects.
+     */
     public List<ExportPluginsInput> getInputs() {
         return List.copyOf(inputs);
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockInstallBoundary.java

@@ -8,6 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the InstallBoundary interface for testing.
+ */
 public class MockInstallBoundary implements InstallBoundary {
     private final List<InstallInput> inputs = new ArrayList<>();
 
@@ -18,6 +21,11 @@ public List<InstallResult> installPlugin(InstallInput installInput) {
         return List.of(new InstallResult(InstallResult.Type.SUCCESS_INSTALLED, installInput.name()));
     }
 
+    /**
+     * Gets a list of all inputs that this interface was invoked with.
+     *
+     * @return A list of input objects.
+     */
     public List<InstallInput> getInputs() {
         return List.copyOf(inputs);
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockListBoundary.java

@@ -8,6 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the ListAllBoundary interface for testing.
+ */
 public class MockListBoundary implements ListAllBoundary {
     private final List<ListType> types = new ArrayList<>();
 
@@ -18,6 +21,11 @@ public List<PluginYml> listAll(ListType parameter) {
         return List.of();
     }
 
+    /**
+     * Gets a list of all types that this interface was invoked with.
+     *
+     * @return A list of type objects.
+     */
     public List<ListType> getTypes() {
         return List.copyOf(types);
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockLoadBoundary.java

@@ -7,6 +7,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the LoadBoundary interface for testing.
+ */
 public class MockLoadBoundary implements LoadBoundary {
     private final List<String> names = new ArrayList<>();
 
@@ -24,14 +27,29 @@ public boolean loadPlugin(String name) throws PluginNotFoundException {
         return defaultResult;
     }
 
+    /**
+     * Sets the default result that this interface will return when invoked.
+     *
+     * @param result The default return value for the load method.
+     */
     public void setDefaultResult(boolean result) {
         this.defaultResult = result;
     }
 
+    /**
+     * Sets whether this interface should throw an exception when invoked.
+     *
+     * @param notFound If true, this interface will throw an exception on invocation.
+     */
     public void setThrowsNotFound(boolean notFound) {
         this.throwsNotFound = notFound;
     }
 
+    /**
+     * Gets a list of all names that this interface was invoked with.
+     *
+     * @return A list of strings that represent plugin names.
+     */
     public List<String> getNames() {
         return List.copyOf(names);
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockMirrorBoundary.java

@@ -10,6 +10,9 @@
 import java.util.Set;
 import java.util.stream.IntStream;
 
+/**
+ * Provides a mock implementation of the MirrorSelectBoundary class.
+ */
 public class MockMirrorBoundary implements MirrorSelectBoundary {
     private Mirror selected;
     private final List<Mirror> mirrors;
@@ -23,6 +26,12 @@ public MockMirrorBoundary(List<Mirror> mirrors) {
         this.selected = mirrors.stream().findFirst().orElse(null);
     }
 
+    /**
+     * Creates a mock Mirror object to pass to this object.
+     *
+     * @param host The provided host that will be used in the mirror initialzation.
+     * @return A Mirror object.
+     */
     public static Mirror mockMirror(String host) {
         return new Mirror(
             host,
@@ -87,14 +96,29 @@ public void setSelectedMirror(Mirror mirror) throws IOException {
         selected = mirror;
     }
 
+    /**
+     * Gets if the mock mirrors object was udpated.
+     *
+     * @return True if the updateMirrors method was invoked at least once.
+     */
     public boolean getDidUpdateMirrors() {
         return didUpdateMirrors;
     }
 
+    /**
+     * Gets if the mirrors were pinged.
+     *
+     * @return True if the pingMirrors object was invoked at least once.
+     */
     public boolean getDidPingMirrors() {
         return didPingMirrors;
     }
 
+    /**
+     * Sets if the methods will throw an exception.
+     *
+     * @param value If true, every boundary method that can throw an IOException will throw one.
+     */
     public void setThrowsIOException(boolean value) {
         throwsIOException = value;
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockPageController.java

@@ -4,6 +4,9 @@
 import org.hydev.mcpm.client.commands.presenters.PagedPresenter;
 import org.jetbrains.annotations.Nullable;
 
+/**
+ * Provides a mock implementation of the PageBoundary interface for testing.
+ */
 public class MockPageController implements PageBoundary {
     @Override
     public int pageSize() {

src/test/java/org/hydev/mcpm/client/arguments/mock/MockRefreshFetcher.java

@@ -7,6 +7,9 @@
 
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the DatabaseFetcher interface for testing RefreshController.
+ */
 public class MockRefreshFetcher implements DatabaseFetcher {
     private boolean fetched = false;
 
@@ -25,6 +28,11 @@ public boolean getFetched() {
         return fetched;
     }
 
+    /**
+     * Sets the default database result that this interface will return when invoked.
+     *
+     * @param database The default return value for the load method.
+     */
     public void setDefaultResult(@Nullable Database database) {
         this.defaultResult = database;
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockReloadBoundary.java

@@ -6,6 +6,9 @@
 import java.util.List;
 import java.util.ArrayList;
 
+/**
+ * Provides a mock implementation of the ReloadBoundary interface for testing.
+ */
 public class MockReloadBoundary implements ReloadBoundary {
     private final List<String> names = new ArrayList<>();
 
@@ -20,10 +23,20 @@ public void reloadPlugin(String name) throws PluginNotFoundException {
         }
     }
 
+    /**
+     * Sets whether this interface should throw an exception when invoked.
+     *
+     * @param notFound If true, this interface will throw an exception on invocation.
+     */
     public void setThrowsNotFound(boolean notFound) {
         this.throwsNotFound = notFound;
     }
 
+    /**
+     * Gets a list of all names that this interface was invoked with.
+     *
+     * @return A list of strings that represent plugin names.
+     */
     public List<String> getNames() {
         return List.copyOf(names);
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockSearchBoundary.java

@@ -7,6 +7,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the SearchBoundary interface for testing.
+ */
 public class MockSearchBoundary implements SearchPackagesBoundary {
     private final List<SearchPackagesInput> inputs = new ArrayList<>();
 
@@ -17,6 +20,11 @@ public SearchPackagesResult search(SearchPackagesInput input) {
         return SearchPackagesResult.by(SearchPackagesResult.State.SUCCESS);
     }
 
+    /**
+     * Gets a list of all inputs that this interface was invoked with.
+     *
+     * @return A list of input objects.
+     */
     public List<SearchPackagesInput> getInputs() {
         return List.copyOf(inputs);
     }

src/test/java/org/hydev/mcpm/client/arguments/mock/MockUninstallBoundary.java

@@ -7,6 +7,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Provides a mock implementation of the UninstallBoundary interface for testing.
+ */
 public class MockUninstallBoundary implements UninstallBoundary {
     private final List<UninstallInput> inputs = new ArrayList<>();
     private UninstallResult.State defaultState = UninstallResult.State.SUCCESS;
@@ -29,6 +32,11 @@ public void setDefaultState(UninstallResult.State state) {
         defaultState = state;
     }
 
+    /**
+     * Gets a list of all inputs that this interface was invoked with.
+     *
+     * @return A list of input objects.
+     */
     public List<UninstallInput> getInputs() {
         return List.copyOf(inputs);
     }