[+] Added tab completer

Author: damt

src/main/java/xyz/damt/command/CommandHandler.java

@@ -5,6 +5,7 @@
 import xyz.damt.command.command.Command;
 import xyz.damt.command.command.CommandFinder;
 import xyz.damt.command.command.CommandRegistery;
+import xyz.damt.command.complete.TabComplete;
 import xyz.damt.command.help.HelpCommandService;
 import xyz.damt.command.provider.CommandProvider;
 import xyz.damt.command.provider.CommandProviderHandler;
@@ -23,6 +24,7 @@ public class CommandHandler {
     private final CommandRegistery commandRegistery;
 
     private HelpCommandService helpCommandService;
+    private TabComplete tabComplete;
 
     /**
      * Command Handler that handles the whole
@@ -72,7 +74,7 @@ public final Command getCommand(String name) {
      */
 
     public final CommandHandler register(Object object, String name) {
-        commandMap.put(name, new CommandFinder(object, commandProviderHandler, helpCommandService).getCommand(name));
+        commandMap.put(name, new CommandFinder(object, commandProviderHandler, helpCommandService, tabComplete).getCommand(name));
         return this;
     }
 
@@ -86,7 +88,7 @@ public final CommandHandler register(Object object, String name) {
 
     public final CommandHandler register(Object... objects) {
         for (Object object : objects) {
-            CommandFinder commandFinder = new CommandFinder(object, commandProviderHandler, helpCommandService);
+            CommandFinder commandFinder = new CommandFinder(object, commandProviderHandler, helpCommandService, tabComplete);
             commandFinder.getCommands().forEach(command -> commandMap.put(command.getName(), command));
         }
         return this;
@@ -104,6 +106,18 @@ public final CommandHandler helpService(HelpCommandService helpCommandService) {
         return this;
     }
 
+    /**
+     * Sets the tab complete of a command
+     *
+     * @param tabComplete tab completer to set to
+     * @return {@link CommandHandler}
+     */
+
+    public final CommandHandler tabComplete(TabComplete tabComplete) {
+        this.tabComplete = tabComplete;
+        return this;
+    }
+
     /**
      * Inputs and registers all commands
      * That are added to the list

src/main/java/xyz/damt/command/annotation/Optional.java

@@ -0,0 +1,14 @@
+package xyz.damt.command.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.PARAMETER)
+public @interface Optional {
+
+    String value();
+
+}

src/main/java/xyz/damt/command/command/Command.java

@@ -8,6 +8,7 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 import xyz.damt.command.CommandHandler;
+import xyz.damt.command.complete.TabComplete;
 import xyz.damt.command.exception.CommandProviderNullException;
 import xyz.damt.command.executor.CommandExecutor;
 import xyz.damt.command.help.HelpCommandService;
@@ -30,6 +31,7 @@ public class Command {
 
     private final CommandExecutor commandExecutor;
     private final HelpCommandService helpCommandService;
+    private final TabComplete tabComplete;
 
     private final List<Command> subCommands = new ArrayList<>();
     private final List<CommandParameter> commandParameters = new ArrayList<>();
@@ -47,7 +49,7 @@ public class Command {
      * @param async       if the command should be ran async or not
      */
 
-    public Command(Object object, String name, String[] aliases, Method method, String description, String usage, HelpCommandService helpCommandService, boolean async) {
+    public Command(Object object, String name, String[] aliases, Method method, String description, String usage, HelpCommandService helpCommandService, TabComplete tabComplete, boolean async) {
         this.object = object;
 
         this.name = name;
@@ -58,6 +60,7 @@ public Command(Object object, String name, String[] aliases, Method method, Stri
         this.usage = usage;
 
         this.helpCommandService = helpCommandService;
+        this.tabComplete = tabComplete;
         this.commandExecutor = new CommandExecutor(this);
     }
 
@@ -103,12 +106,15 @@ public void execute(CommandSender commandSender, String[] args) {
             try {
                 objects.add(commandParameter.getCommandProvider().provide(args[commandParameters.indexOf(commandParameter)]));
             } catch (CommandProviderNullException e) {
-                if (e.getMessage() == null) {
-                    commandSender.sendMessage(ChatColor.RED + "The argument '" + commandParameter.getName() + "' is null!");
+                if (!commandParameter.isOptional()) {
+                    if (e.getMessage() == null) {
+                        commandSender.sendMessage(ChatColor.RED + "The argument '" + commandParameter.getName() + "' is null!");
+                        return;
+                    }
+
+                    commandSender.sendMessage(e.getMessage());
                     return;
                 }
-                commandSender.sendMessage(e.getMessage());
-                return;
             }
         }
 

src/main/java/xyz/damt/command/command/CommandFinder.java

@@ -3,6 +3,7 @@
 import org.bukkit.entity.Player;
 import xyz.damt.command.annotation.Permission;
 import xyz.damt.command.annotation.Sender;
+import xyz.damt.command.complete.TabComplete;
 import xyz.damt.command.help.HelpCommandService;
 import xyz.damt.command.provider.CommandProviderHandler;
 
@@ -18,6 +19,7 @@ public class CommandFinder {
 
     private final CommandProviderHandler commandProviderHandler;
     private final HelpCommandService helpCommandService;
+    private final TabComplete tabComplete;
 
     private final List<Command> commands = new ArrayList<>();
 
@@ -28,11 +30,12 @@ public class CommandFinder {
      * @param object {@link Object}
      */
 
-    public CommandFinder(Object object, CommandProviderHandler commandProviderHandler, HelpCommandService helpCommandService) {
+    public CommandFinder(Object object, CommandProviderHandler commandProviderHandler, HelpCommandService helpCommandService, TabComplete tabComplete) {
         this.object = object;
 
         this.commandProviderHandler = commandProviderHandler;
         this.helpCommandService = helpCommandService;
+        this.tabComplete = tabComplete;
 
         this.init();
         this.edit();
@@ -101,7 +104,7 @@ private final void init() {
 
             if (commandAnnotation != null) {
                 Permission permissionAnnotation = method.getAnnotation(Permission.class);
-                Command command = new Command(object, commandAnnotation.value(), commandAnnotation.aliases(), method, commandAnnotation.description(), commandAnnotation.usage(), helpCommandService, commandAnnotation.async());
+                Command command = new Command(object, commandAnnotation.value(), commandAnnotation.aliases(), method, commandAnnotation.description(), commandAnnotation.usage(), helpCommandService, tabComplete, commandAnnotation.async());
 
                 if (permissionAnnotation != null) {
                     command.setPermission(permissionAnnotation.permission());

src/main/java/xyz/damt/command/command/CommandParameter.java

@@ -3,6 +3,7 @@
 import lombok.Getter;
 import lombok.SneakyThrows;
 import xyz.damt.command.annotation.Name;
+import xyz.damt.command.annotation.Optional;
 import xyz.damt.command.exception.CommandParameterException;
 import xyz.damt.command.provider.CommandProvider;
 import xyz.damt.command.provider.CommandProviderHandler;
@@ -17,6 +18,7 @@ public class CommandParameter {
     private final CommandProviderHandler commandProviderHandler;
 
     private CommandProvider<?> commandProvider;
+    private boolean optional, text;
     private String name;
 
     @SneakyThrows
@@ -35,11 +37,18 @@ private final void init() throws CommandParameterException {
             this.name = parameter.getName();
         else this.name = name.value();
 
+        Optional optional = parameter.getAnnotation(Optional.class);
+
+        if (optional != null) {
+            this.optional = true;
+            this.name = optional.value();
+        }
+
         this.commandProvider = commandProviderHandler.getProvider(parameter);
 
         if (commandProvider == null)
             throw new CommandParameterException("The command parameter '" + parameter.getType().getSimpleName() + "' for command " + command
-            .getName() + " does not exist!");
+                    .getName() + " does not exist!");
     }
 
 }

src/main/java/xyz/damt/command/complete/TabComplete.java

@@ -0,0 +1,11 @@
+package xyz.damt.command.complete;
+
+import xyz.damt.command.command.Command;
+
+import java.util.List;
+
+public interface TabComplete {
+
+    List<String> get(Command command, List<Command> subCommands, String[] args);
+
+}

src/main/java/xyz/damt/command/complete/impl/DefaultTabCompleter.java

@@ -0,0 +1,27 @@
+package xyz.damt.command.complete.impl;
+
+import xyz.damt.command.command.Command;
+import xyz.damt.command.complete.TabComplete;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class DefaultTabCompleter implements TabComplete {
+
+    @Override
+    public List<String> get(Command command, List<Command> subCommands, String[] args) {
+        final List<String> strings = subCommands.stream().map(Command::getName).collect(Collectors.toList());
+
+        for (String string : strings) {
+            final String[] stringArgs = string.split("\\s+");
+            strings.remove(string);
+
+            for (int i = args.length; i < stringArgs.length; i++) {
+                strings.add(stringArgs[i]);
+            }
+        }
+
+        return strings;
+    }
+
+}

src/main/java/xyz/damt/command/executor/CommandExecutor.java

@@ -1,13 +1,11 @@
 package xyz.damt.command.executor;
 
-import com.google.common.collect.Lists;
 import org.bukkit.command.CommandSender;
 import org.bukkit.command.defaults.BukkitCommand;
 import xyz.damt.command.command.Command;
 import xyz.damt.command.command.CommandParameter;
 
 import java.util.Arrays;
-import java.util.Collections;
 import java.util.List;
 
 public class CommandExecutor extends BukkitCommand {
@@ -63,7 +61,7 @@ public List<String> tabComplete(CommandSender sender, String alias, String[] arg
         CommandParameter commandParameter = command.getCommandParameters().get(args.length);
 
         if (commandParameter == null)
-            return Collections.emptyList();
+            return command.getTabComplete().get(command, command.getSubCommands(), args);
 
         return commandParameter.getCommandProvider().suggestions(commandParameter);
     }