[+] Added help command service

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.help.HelpCommandService;
 import xyz.damt.command.provider.CommandProvider;
 import xyz.damt.command.provider.CommandProviderHandler;
 
@@ -21,6 +22,8 @@ public class CommandHandler {
     private final CommandProviderHandler commandProviderHandler;
     private final CommandRegistery commandRegistery;
 
+    private HelpCommandService helpCommandService;
+
     /**
      * Command Handler that handles the whole
      * registery process of the commands
@@ -69,7 +72,7 @@ public final Command getCommand(String name) {
      */
 
     public final CommandHandler register(Object object, String name) {
-        commandMap.put(name, new CommandFinder(object, commandProviderHandler).getCommand(name));
+        commandMap.put(name, new CommandFinder(object, commandProviderHandler, helpCommandService).getCommand(name));
         return this;
     }
 
@@ -83,12 +86,24 @@ public final CommandHandler register(Object object, String name) {
 
     public final CommandHandler register(Object... objects) {
         for (Object object : objects) {
-            CommandFinder commandFinder = new CommandFinder(object, commandProviderHandler);
+            CommandFinder commandFinder = new CommandFinder(object, commandProviderHandler, helpCommandService);
             commandFinder.getCommands().forEach(command -> commandMap.put(command.getName(), command));
         }
         return this;
     }
 
+    /**
+     * Sets the help command service
+     *
+     * @param helpCommandService help command service to set to
+     * @return {@link CommandHandler}
+     */
+
+    public final CommandHandler helpService(HelpCommandService helpCommandService) {
+        this.helpCommandService = helpCommandService;
+        return this;
+    }
+
     /**
      * Inputs and registers all commands
      * That are added to the list
@@ -110,4 +125,5 @@ public final CommandHandler registerCommands() {
     public JavaPlugin getJavaPlugin() {
         return javaPlugin;
     }
+
 }

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

@@ -10,8 +10,10 @@
 import xyz.damt.command.CommandHandler;
 import xyz.damt.command.exception.CommandProviderNullException;
 import xyz.damt.command.executor.CommandExecutor;
+import xyz.damt.command.help.HelpCommandService;
 
 import java.lang.reflect.Method;
+import java.util.ArrayList;
 import java.util.LinkedList;
 import java.util.List;
 
@@ -27,8 +29,10 @@ public class Command {
     private final Object object;
 
     private final CommandExecutor commandExecutor;
-    private final List<Command> subCommands = new LinkedList<>();
-    private final List<CommandParameter> commandParameters = new LinkedList<>();
+    private final HelpCommandService helpCommandService;
+
+    private final List<Command> subCommands = new ArrayList<>();
+    private final List<CommandParameter> commandParameters = new ArrayList<>();
 
     private boolean player;
     private String permission, permissionMessage;
@@ -43,7 +47,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, boolean async) {
+    public Command(Object object, String name, String[] aliases, Method method, String description, String usage, HelpCommandService helpCommandService, boolean async) {
         this.object = object;
 
         this.name = name;
@@ -53,6 +57,7 @@ public Command(Object object, String name, String[] aliases, Method method, Stri
         this.async = async;
         this.usage = usage;
 
+        this.helpCommandService = helpCommandService;
         this.commandExecutor = new CommandExecutor(this);
     }
 
@@ -82,28 +87,30 @@ public void execute(CommandSender commandSender, String[] args) {
             return;
         }
 
+        if (args.length == 0 && !getSubCommands().isEmpty() && helpCommandService != null) {
+            helpCommandService.get(this, getSubCommands()).forEach(commandSender::sendMessage);
+            return;
+        }
+
         if (args.length < commandParameters.size()) {
             commandSender.sendMessage(ChatColor.RED + "Wrong Usage: " + usage);
             return;
         }
 
         List<Object> objects = new LinkedList<>();
 
-        commandParameters.forEach(commandParameter -> {
-
+        for (CommandParameter commandParameter : commandParameters) {
             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!");
                     return;
                 }
-
                 commandSender.sendMessage(e.getMessage());
                 return;
             }
-
-        });
+        }
 
         if (player) {
             Player player = (Player) commandSender;

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.help.HelpCommandService;
 import xyz.damt.command.provider.CommandProviderHandler;
 
 import java.lang.reflect.Method;
@@ -14,7 +15,10 @@
 public class CommandFinder {
 
     private final Object object;
+
     private final CommandProviderHandler commandProviderHandler;
+    private final HelpCommandService helpCommandService;
+
     private final List<Command> commands = new ArrayList<>();
 
     /**
@@ -24,9 +28,11 @@ public class CommandFinder {
      * @param object {@link Object}
      */
 
-    public CommandFinder(Object object, CommandProviderHandler commandProviderHandler) {
+    public CommandFinder(Object object, CommandProviderHandler commandProviderHandler, HelpCommandService helpCommandService) {
         this.object = object;
+
         this.commandProviderHandler = commandProviderHandler;
+        this.helpCommandService = helpCommandService;
 
         this.init();
         this.edit();
@@ -95,7 +101,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(), commandAnnotation.async());
+                Command command = new Command(object, commandAnnotation.value(), commandAnnotation.aliases(), method, commandAnnotation.description(), commandAnnotation.usage(), helpCommandService, commandAnnotation.async());
 
                 if (permissionAnnotation != null) {
                     command.setPermission(permissionAnnotation.permission());

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

@@ -1,5 +1,6 @@
 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;
@@ -59,16 +60,12 @@ public boolean execute(CommandSender commandSender, String s, String[] strings)
 
     @Override
     public List<String> tabComplete(CommandSender sender, String alias, String[] args) throws IllegalArgumentException {
-        for (int i = 0; i < args.length; i++) {
-            CommandParameter commandParameter = command.getCommandParameters().get(i);
+        CommandParameter commandParameter = command.getCommandParameters().get(args.length);
 
-            if (commandParameter == null)
-                return Collections.emptyList();
+        if (commandParameter == null)
+            return Collections.emptyList();
 
-            return commandParameter.getCommandProvider().suggestions(commandParameter);
-        }
-
-        return Collections.emptyList();
+        return commandParameter.getCommandProvider().suggestions(commandParameter);
     }
 
 }

src/main/java/xyz/damt/command/help/HelpCommandService.java

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

src/main/java/xyz/damt/command/help/impl/DefaultHelpCommandService.java

@@ -0,0 +1,35 @@
+package xyz.damt.command.help.impl;
+
+import org.bukkit.ChatColor;
+import xyz.damt.command.command.Command;
+import xyz.damt.command.help.HelpCommandService;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class DefaultHelpCommandService implements HelpCommandService {
+
+    private final String mainColor;
+    private final String secondaryColor;
+
+    public DefaultHelpCommandService(String mainColor, String secondaryColor) {
+        this.mainColor = mainColor;
+        this.secondaryColor = secondaryColor;
+    }
+
+    @Override
+    public List<String> get(Command command, List<Command> subCommands) {
+        final List<String> strings = new ArrayList<>();
+
+        strings.add(mainColor + command.getName() + secondaryColor + "'s Commands");
+        subCommands.forEach(command1 -> strings.add(mainColor + command1.getUsage() + secondaryColor + " - " + command1.getDescription()));
+
+        return translate(strings);
+    }
+
+    private final List<String> translate(List<String> strings) {
+        return strings.stream().map(string -> ChatColor.translateAlternateColorCodes('&', string)).collect(Collectors.toList());
+    }
+
+}

src/test/java/xyz/damt/example/Main.java

@@ -4,6 +4,7 @@
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.plugin.java.JavaPlugin;
 import xyz.damt.command.CommandHandler;
+import xyz.damt.command.help.impl.DefaultHelpCommandService;
 import xyz.damt.example.command.FlyCommand;
 import xyz.damt.example.command.ItemStackCommand;
 import xyz.damt.example.provider.ItemStackProvider;
@@ -22,7 +23,7 @@ public void onLoad() {
     @Override
     public void onEnable() {
         new CommandHandler(this).bind(ItemStack.class, new ItemStackProvider())
-                .register(new FlyCommand(), new ItemStackCommand()).registerCommands();
+                .register(new FlyCommand(), new ItemStackCommand()).helpService(new DefaultHelpCommandService("&c", "&7")).registerCommands();
     }
 
 }