Javadocs for load arguments

Author: ZeroMemes

src/main/java/clientapi/load/ClientTweaker.java

@@ -106,8 +106,8 @@ public final String[] getLaunchArguments() {
         // Parse the arguments that are already being passed to the game
         List<Argument> existing = Arguments.parse((List<String>) Launch.blackboard.get("ArgumentList"));
 
-        // Remove any arguments that match already existing ones
-        parsed.removeIf(argument -> existing.stream().anyMatch(a -> a.matches(argument)));
+        // Remove any arguments that conflict with existing ones
+        parsed.removeIf(argument -> existing.stream().anyMatch(a -> a.conflicts(argument)));
 
         // Join back the filtered arguments and pass those to the game
         return Arguments.join(parsed).toArray(new String[0]);

src/main/java/clientapi/load/argument/Argument.java

@@ -19,12 +19,30 @@
 import java.util.List;
 
 /**
+ * A standard launch argument
+ *
  * @author Brady
  * @since 10/9/2018
  */
 public interface Argument {
 
+    /**
+     * Adds the "components" of this argument to the specified list.
+     *
+     * @see ClassifiedArgument#addToList(List)
+     * @see SingularArgument#addToList(List)
+     *
+     * @param arguments The argument list
+     */
     void addToList(List<String> arguments);
 
-    boolean matches(Argument argument);
+    /**
+     * Returns whether or not this argument conflicts with the specified one. In the context
+     * of singular arguments, this means that the singular argument itself matches, in the context
+     * of classified arguments, this means that the classifier matches.
+     *
+     * @param argument Another argument
+     * @return Whether or not this argument conflicts
+     */
+    boolean conflicts(Argument argument);
 }

src/main/java/clientapi/load/argument/Arguments.java

@@ -20,11 +20,19 @@
 import java.util.List;
 
 /**
+ * Helper for argument parsing
+ *
  * @author Brady
  * @since 10/9/2018
  */
 public final class Arguments {
 
+    /**
+     * Parses a list of raw arguments into a list of joined classifier and singular ones.
+     *
+     * @param args The arguments to parse
+     * @return The parsed arguments
+     */
     public static List<Argument> parse(List<String> args) {
         List<Argument> argsOut = new ArrayList<>();
 
@@ -53,6 +61,12 @@ public static List<Argument> parse(List<String> args) {
         return argsOut;
     }
 
+    /**
+     * Joins a list of arguments back into a string list format
+     *
+     * @param args The arguments
+     * @return The joined arguments
+     */
     public static List<String> join(List<Argument> args) {
         List<String> argsOut = new ArrayList<>();
         args.forEach(argument -> argument.addToList(argsOut));

src/main/java/clientapi/load/argument/ClassifiedArgument.java

@@ -27,7 +27,7 @@ public final class ClassifiedArgument implements Argument {
     private final String classifier;
     private final String value;
 
-    public ClassifiedArgument(String classifier, String value) {
+    ClassifiedArgument(String classifier, String value) {
         this.classifier = classifier;
         this.value = value;
     }
@@ -39,7 +39,7 @@ public final void addToList(List<String> arguments) {
     }
 
     @Override
-    public final boolean matches(Argument argument) {
+    public final boolean conflicts(Argument argument) {
         if (!(argument instanceof ClassifiedArgument))
             return false;
 

src/main/java/clientapi/load/argument/SingularArgument.java

@@ -26,7 +26,7 @@ public final class SingularArgument implements Argument {
 
     private final String value;
 
-    public SingularArgument(String value) {
+    SingularArgument(String value) {
         this.value = value;
     }
 
@@ -36,7 +36,7 @@ public final void addToList(List<String> arguments) {
     }
 
     @Override
-    public final boolean matches(Argument argument) {
+    public final boolean conflicts(Argument argument) {
         if (!(argument instanceof SingularArgument))
             return false;