modified return types of getPlayer and getEntity to remove the exception type

Author: DatAsianBoi123

src/main/java/com/datasiqn/commandcore/CommandCore.java

@@ -115,6 +115,12 @@ public static CommandCore getInstance() {
         return instance;
     }
 
+    /**
+     * Sends command usage to {@code sender}
+     * @param sender The sender
+     * @param commandName The name of the command
+     * @throws IllegalArgumentException If {@code commandName} is not the name of a command
+     */
     public void sendCommandHelp(@NotNull CommandSender sender, @NotNull String commandName) {
         if (!commandManager.hasCommand(commandName)) throw new IllegalArgumentException("Command " + commandName + " does not exist");
         Command command = commandManager.getCommand(commandName);
@@ -124,6 +130,10 @@ public void sendCommandHelp(@NotNull CommandSender sender, @NotNull String comma
         sender.sendMessage(getUsagesFor(commandName, 2).toArray(new String[0]));
     }
 
+    /**
+     * Sends the help menu to {@code sender}
+     * @param sender The sender
+     */
     public void sendHelpMenu(@NotNull CommandSender sender) {
         sender.sendMessage(ChatColor.GOLD + (options.hasCustomPluginName() ? options.getPluginName() : plugin.getName()) + " Commands");
         commandManager.allCommands().keySet().stream().sorted().forEach(name -> {
@@ -132,6 +142,13 @@ public void sendHelpMenu(@NotNull CommandSender sender) {
         });
     }
 
+    /**
+     * Generates a formatted string for each usage of a command
+     * @param commandName The name of the command
+     * @param spaces The # of spaces to add before each usage string
+     * @return A list of formatted strings representing all usages for the command
+     * @throws IllegalArgumentException If {@code commandName} is not the name of a command
+     */
     @NotNull
     public List<String> getUsagesFor(String commandName, int spaces) {
         if (!commandManager.hasCommand(commandName))
@@ -153,6 +170,10 @@ public List<String> getUsagesFor(String commandName, int spaces) {
         return usages;
     }
 
+    /**
+     * Gets the options used to initialize {@code CommandCore}
+     * @return The options used to initialize {@code CommandCore}
+     */
     public InitOptions getOptions() {
         return options;
     }

src/main/java/com/datasiqn/commandcore/InitOptions.java

@@ -2,19 +2,28 @@
 
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.UnmodifiableView;
 
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 
+/**
+ * Initialization options used when initializing {@code CommandCore}. Cannot be created directly, and must use a {@code Builder} to create one.
+ * @see Builder
+ */
 public class InitOptions {
     private final String rootCommand;
     private final String pluginName;
     private final boolean helpCommand;
     private final boolean legacyExecutor;
     private final List<String> aliases;
 
+    /**
+     * Creates an {@code InitOptions} from a {@code Builder}
+     * @param builder The builder
+     */
     @Contract(pure = true)
     public InitOptions(@NotNull Builder builder) {
         this.rootCommand = builder.rootCommand;
@@ -24,67 +33,127 @@ public InitOptions(@NotNull Builder builder) {
         this.legacyExecutor = builder.legacyExecutor;
     }
 
+    /**
+     * Gets the root command
+     * @return The root command
+     */
     public String getRootCommand() {
         return rootCommand;
     }
 
+    /**
+     * Gets whether the user has defined a custom plugin name or not
+     * @return True if there is a custom plugin name, false otherwise
+     */
     public boolean hasCustomPluginName() {
         return pluginName != null;
     }
 
-    public String getPluginName() {
+    /**
+     * Gets the custom plugin name
+     * @return The custom plugin name, or null if there is none
+     */
+    public @Nullable String getPluginName() {
         return pluginName;
     }
 
+    /**
+     * Gets all the command's aliases
+     * @return An unmodifiable view of all the command's aliases
+     */
     @UnmodifiableView
     public List<String> getAliases() {
         return Collections.unmodifiableList(aliases);
     }
 
+    /**
+     * Gets whether a help command should be generated or not
+     * @return True if a help command should be generated, false otherwise
+     */
     public boolean createHelpCommand() {
         return helpCommand;
     }
 
+    /**
+     * Gets whether the legacy executor should be used or not
+     * @return True if the legacy executor should be used, false otherwise
+     */
     public boolean useLegacyExecutor() {
         return legacyExecutor;
     }
 
+    /**
+     * Builder class to create an {@code InitOptions} object
+     */
     public static class Builder {
         private final String rootCommand;
         private String pluginName;
         private boolean helpCommand = true;
         private boolean legacyExecutor = false;
         private String[] aliases = new String[0];
 
+        /**
+         * Creates a new {@code Builder} class
+         * @param rootCommand The name of the root command that be the root all {@code CommandCore} commands
+         */
         public Builder(String rootCommand) {
             this.rootCommand = rootCommand;
         }
 
+        /**
+         * Sets whether a help command should be created or not
+         * @param flag True if a help command should be created, false if it shouldn't
+         * @return The builder, for chaining
+         */
         public Builder createHelpCommand(boolean flag) {
             this.helpCommand = flag;
             return this;
         }
 
+        /**
+         * Sets the custom plugin name that appears when showing the help screen
+         * @param name The custom plugin name
+         * @return The builder, for chaining
+         */
         public Builder pluginName(String name) {
             this.pluginName = name;
             return this;
         }
 
+        /**
+         * Sets the aliases of the root command
+         * @param aliases The aliases
+         * @return The builder, for chaining
+         */
         public Builder aliases(String... aliases) {
             this.aliases = aliases;
             return this;
         }
 
+        /**
+         * Tells {@code CommandCore} to use the legacy executor when executing a command
+         * @deprecated You should not use this ever, since the legacy executor is very buggy and can cause lots of problems if used
+         * @return The builder, for chaining
+         */
         @Deprecated
         public Builder useLegacyExecutor() {
             this.legacyExecutor = true;
             return this;
         }
 
+        /**
+         * Creates a new {@code InitOptions} based off this builder
+         * @return The newly created {@code InitOptions} instance
+         */
         public InitOptions build() {
             return new InitOptions(this);
         }
 
+        /**
+         * Creates a new {@code Builder} instance. This is identical to calling {@code new Builder(rootCommand)}.
+         * @param rootCommand The name of the root command that will be the root of all {@code CommandCore} commands
+         * @return The newly created {@code Builder} instance
+         */
         @Contract(value = "_ -> new", pure = true)
         public static @NotNull Builder create(@NotNull String rootCommand) {
             return new Builder(rootCommand);

src/main/java/com/datasiqn/commandcore/arguments/ListArguments.java

@@ -8,6 +8,10 @@
 public class ListArguments implements Arguments {
     protected final List<String> allArguments;
 
+    /**
+     * Creates a new {@code ListArguments}
+     * @param args The arguments in a string list
+     */
     public ListArguments(List<String> args) {
         allArguments = args;
     }

src/main/java/com/datasiqn/commandcore/commands/Command.java

@@ -33,5 +33,9 @@ public interface Command {
      */
     @NotNull List<String> getUsages();
 
+    /**
+     * Gets the aliases of this command
+     * @return The aliases
+     */
     @NotNull String[] getAliases();
 }

src/main/java/com/datasiqn/commandcore/commands/CommandExecutor.java

@@ -8,6 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * Represents an executor for a command
+ */
 public interface CommandExecutor {
     /**
      * Executes this command executor

src/main/java/com/datasiqn/commandcore/commands/CommandSource.java

@@ -1,12 +1,16 @@
 package com.datasiqn.commandcore.commands;
 
+import com.datasiqn.commandcore.commands.builder.CommandLink;
 import com.datasiqn.resultapi.Result;
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Entity;
 import org.bukkit.entity.Player;
 import org.bukkit.permissions.Permission;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * Represents the source of a command
+ */
 public interface CommandSource {
     /**
      * Gets the player executing command
@@ -22,9 +26,23 @@ public interface CommandSource {
     @NotNull
     Result<Entity, String> getEntity();
 
-    @NotNull CommandSender getSender();
-
-    boolean hasPermission(Permission permissible);
+    /**
+     * Gets the sender of the command
+     * @return The sender
+     */
+    @NotNull
+    CommandSender getSender();
 
+    /**
+     * Gets whether the source of the command has a permission or not
+     * @param permission The permission
+     * @return True if the source has {@code permission}, false otherwise
+     */
+    boolean hasPermission(Permission permission);
+    /**
+     * Gets whether the source of the command has a permission or not
+     * @param permission The permission
+     * @return True if the source has {@code permission}, false otherwise
+     */
     boolean hasPermission(String permission);
 }

src/main/java/com/datasiqn/commandcore/commands/builder/CommandBuilder.java

@@ -44,6 +44,11 @@ public CommandBuilder description(String description) {
         return this;
     }
 
+    /**
+     * Sets the command's aliases
+     * @param aliases The aliases
+     * @return The builder, for chaining
+     */
     public CommandBuilder alias(String... aliases) {
         this.aliases = aliases;
         return this;

src/main/java/com/datasiqn/commandcore/managers/CommandManager.java

@@ -9,6 +9,9 @@
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * Class that manages all commands
+ */
 public class CommandManager {
     private final Map<String, Command> executableCommands = new HashMap<>();
     private final Map<String, Command> commandMap = new HashMap<>();

src/main/java/com/datasiqn/commandcore/util/ParseUtil.java

@@ -2,10 +2,19 @@
 
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * A utility class that contains parsing methods
+ */
 public final class ParseUtil {
     private ParseUtil() {}
 
-    public static boolean strictParseBoolean(@NotNull String str) throws IllegalArgumentException {
+    /**
+     * Strictly parses {@code str} as a boolean
+     * @param str The string to parse
+     * @return {@code true} if {@code str} equals "true", or {@code false} if {@code str} equals "false"
+     * @throws IllegalArgumentException If {@code str} does not equal "true" or "false"
+     */
+    public static boolean strictParseBoolean(@NotNull String str) {
         if (str.equalsIgnoreCase("true")) return true;
         else if (str.equalsIgnoreCase("false")) return false;
         throw new IllegalArgumentException("String '" + str + "' is not a boolean");