Refactor CommandScopes

Command scopes have been changed from arbitrary strings to proper enum instances. The
new CommandScope enum class contains the following values:

 - PLAYER (Player)
 - CONSOLE (ConsoleCommandSender)
 - BLOCK (Command Block)
 - ANY (any CommandSender)

Author: BGMP

bukkit/src/main/java/cl/bgm/bukkit/util/BukkitCommandsManager.java

@@ -1,5 +1,6 @@
 package cl.bgm.bukkit.util;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
 import cl.bgm.minecraft.util.commands.CommandsManager;
 import org.bukkit.command.BlockCommandSender;
 import org.bukkit.command.CommandSender;
@@ -14,13 +15,15 @@ public boolean hasPermission(CommandSender player, String perm) {
     }
 
     @Override
-    public boolean scopeMatches(CommandSender player, String scope) {
-        switch (scope.toLowerCase()) {
-            case "player":
+    public boolean scopeMatches(CommandSender player, CommandScope scope) {
+        switch (scope) {
+            case ANY:
+                return true;
+            case PLAYER:
                 return player instanceof Player;
-            case "console":
+            case CONSOLE:
                 return player instanceof ConsoleCommandSender;
-            case "block":
+            case BLOCK:
                 return player instanceof BlockCommandSender;
             default:
                 return false;

bungee/src/main/java/cl/bgm/bungee/util/BungeeCommandsManager.java

@@ -1,5 +1,6 @@
 package cl.bgm.bungee.util;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
 import cl.bgm.minecraft.util.commands.CommandsManager;
 import net.md_5.bungee.api.CommandSender;
 
@@ -12,11 +13,13 @@ public boolean hasPermission(CommandSender player, String perm) {
     }
 
     @Override
-    public boolean scopeMatches(CommandSender player, String scope) {
-        switch (scope.toLowerCase()) {
-            case "player":
+    public boolean scopeMatches(CommandSender player, CommandScope scope) {
+        switch (scope) {
+            case ANY:
+                return true;
+            case PLAYER:
                 return player instanceof ProxiedPlayer;
-            case "console":
+            case CONSOLE:
                 return !(player instanceof ProxiedPlayer);
             default:
                 return false;

core/src/main/java/cl/bgm/minecraft/util/commands/CommandScope.java

@@ -0,0 +1,9 @@
+package cl.bgm.minecraft.util.commands;
+
+public enum CommandScope {
+    PLAYER,
+    CONSOLE,
+    BLOCK,
+
+    ANY,
+}

core/src/main/java/cl/bgm/minecraft/util/commands/CommandsManager.java

@@ -659,7 +659,7 @@ protected boolean scopeMatches(Method method, T player) {
             return true;
         }
 
-        for (String scope : scopes.value()) {
+        for (CommandScope scope : scopes.value()) {
             if (scopeMatches(player, scope)) {
                 return true;
             }
@@ -684,7 +684,7 @@ protected boolean scopeMatches(Method method, T player) {
      * @param scope the permission
      * @return true if the scope matches
      */
-    public abstract boolean scopeMatches(T player, String scope);
+    public abstract boolean scopeMatches(T player, CommandScope scope);
 
     /**
      * Get the injector used to create new instances. This can be

core/src/main/java/cl/bgm/minecraft/util/commands/annotations/CommandScopes.java

@@ -1,5 +1,7 @@
 package cl.bgm.minecraft.util.commands.annotations;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
+
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 
@@ -13,5 +15,5 @@
      * The command's target scopes, which by default are all possible senders
      * @return them
      */
-    String[] value() default {"console", "player", "block"};
+    CommandScope[] value() default { CommandScope.ANY };
 }

core/src/main/java/cl/bgm/minecraft/util/commands/exceptions/ScopeMismatchException.java

@@ -1,17 +1,19 @@
 package cl.bgm.minecraft.util.commands.exceptions;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
+
 /**
  * Thrown when the command scope doesn't match the sender
  */
 public class ScopeMismatchException extends CommandException {
-    String[] scopes;
+    CommandScope[] scopes;
 
-    public ScopeMismatchException(String message, String[] scopes) {
+    public ScopeMismatchException(String message, CommandScope[] scopes) {
         super(message);
         this.scopes = scopes;
     }
 
-    public String[] getScopes() {
+    public CommandScope[] getScopes() {
         return scopes;
     }
 }

core/src/main/java/cl/bgm/minecraft/util/commands/wrapped/WrappedCommandsManager.java

@@ -1,21 +1,28 @@
 package cl.bgm.minecraft.util.commands.wrapped;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
 import cl.bgm.minecraft.util.commands.CommandsManager;
 
+import static cl.bgm.minecraft.util.commands.CommandScope.BLOCK;
+import static cl.bgm.minecraft.util.commands.CommandScope.CONSOLE;
+import static cl.bgm.minecraft.util.commands.CommandScope.PLAYER;
+
 public class WrappedCommandsManager extends CommandsManager<WrappedCommandSender> {
     @Override
     public boolean hasPermission(WrappedCommandSender player, String perm) {
         return player.hasPermission(perm);
     }
 
     @Override
-    public boolean scopeMatches(WrappedCommandSender player, String scope) {
-        switch (scope.toLowerCase()) {
-            case "player":
+    public boolean scopeMatches(WrappedCommandSender player, CommandScope scope) {
+        switch (scope) {
+            case ANY:
+                return true;
+            case PLAYER:
                 return player.getType() == WrappedCommandSender.Type.PLAYER;
-            case "console":
+            case CONSOLE:
                 return player.getType() == WrappedCommandSender.Type.CONSOLE;
-            case "block":
+            case BLOCK:
                 return player.getType() == WrappedCommandSender.Type.BLOCK;
             default:
                 return false; // When unknown

example-commands-bukkit/src/main/java/cl/bgm/example/commands/bukkit/ExampleCommandsBukkit.java

@@ -4,6 +4,8 @@
 import cl.bgm.bukkit.util.CommandsManagerRegistration;
 import cl.bgm.example.commands.bukkit.commands.ExampleNestedCommand;
 import cl.bgm.example.commands.bukkit.commands.ExampleCommand;
+import cl.bgm.minecraft.util.commands.CommandScope;
+import cl.bgm.minecraft.util.commands.annotations.CommandScopes;
 import cl.bgm.minecraft.util.commands.exceptions.CommandException;
 import cl.bgm.minecraft.util.commands.exceptions.CommandPermissionsException;
 import cl.bgm.minecraft.util.commands.exceptions.CommandUsageException;
@@ -31,11 +33,13 @@ public boolean onCommand(CommandSender sender, Command command, String label, St
         try {
             this.commandsManager.execute(command.getName(), args, sender, sender);
         } catch (ScopeMismatchException exception) {
-            String[] scopes = exception.getScopes();
-            if (!Arrays.asList(scopes).contains("player")) {
-                sender.sendMessage("You must use the console to execute this command.");
-            } else {
-                sender.sendMessage("You must be a player to execute this command.");
+            CommandScope[] scopes = exception.getScopes();
+            if (!Arrays.asList(scopes).contains(CommandScope.PLAYER)) {
+                sender.sendMessage("A player cannot execute this command.");
+            } else if (!Arrays.asList(scopes).contains(CommandScope.CONSOLE)) {
+                sender.sendMessage("The console cannot execute this command.");
+            } else if (!Arrays.asList(scopes).contains(CommandScope.BLOCK)) {
+                sender.sendMessage("A command block cannot execute this command.");
             }
         } catch (CommandPermissionsException exception) {
             sender.sendMessage("You do not have permission.");

example-commands-bukkit/src/main/java/cl/bgm/example/commands/bukkit/commands/ExampleCommand.java

@@ -1,5 +1,6 @@
 package cl.bgm.example.commands.bukkit.commands;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
 import cl.bgm.minecraft.util.commands.annotations.Command;
 import cl.bgm.minecraft.util.commands.CommandContext;
 import cl.bgm.minecraft.util.commands.annotations.CommandPermissions;
@@ -20,7 +21,7 @@ public class ExampleCommand {
             max = 1
     )
     @CommandPermissions("example.command")
-    @CommandScopes({"player"})
+    @CommandScopes(CommandScope.PLAYER)
     public static void example(final CommandContext args, final CommandSender sender) {
         if (args.argsLength() == 1) {
             sender.sendMessage("I'm a " + args.getString(0));

example-commands-bukkit/src/main/java/cl/bgm/example/commands/bukkit/commands/ExampleNestedCommand.java

@@ -1,5 +1,6 @@
 package cl.bgm.example.commands.bukkit.commands;
 
+import cl.bgm.minecraft.util.commands.CommandScope;
 import cl.bgm.minecraft.util.commands.annotations.Command;
 import cl.bgm.minecraft.util.commands.CommandContext;
 import cl.bgm.minecraft.util.commands.annotations.CommandPermissions;
@@ -22,7 +23,7 @@ public class ExampleNestedCommand {
             max = 1
     )
     @CommandPermissions("hello.command.me")
-    @CommandScopes({"player"})
+    @CommandScopes(CommandScope.PLAYER)
     public static void me(final CommandContext args, final CommandSender sender) {
         if (args.argsLength() == 0) {
             sender.sendMessage("hello me");
@@ -38,7 +39,7 @@ public static void me(final CommandContext args, final CommandSender sender) {
             max = 1
     )
     @CommandPermissions("hello.command.you")
-    @CommandScopes({"player"})
+    @CommandScopes(CommandScope.PLAYER)
     public static void you(final CommandContext args, final CommandSender sender) {
         if (args.argsLength() == 0) {
             sender.sendMessage("hello you");
@@ -54,7 +55,7 @@ public static class ExampleNestedCommandNode {
                 desc = "Hello node command."
         )
         @CommandPermissions("hello.command")
-        @CommandScopes({"player"})
+        @CommandScopes(CommandScope.PLAYER)
         @NestedCommand(value = ExampleNestedCommand.class, executeBody = true)
         public static void hello(final CommandContext args, final CommandSender sender) {
             sender.sendMessage("I'm the method body.");