Adjusted Command Processing

Completion annotations have been moved to top level, from per method, for a much clearer understanding of how the annotation should be used.

Datura/src/main/java/me/totalfreedom/datura/cmd/CageCommand.java

@@ -37,6 +37,9 @@ import org.jetbrains.annotations.NotNull;
 @Info(name = "cage", description = "Cage a player.",
         usage = "/cage <player> <on|off> [material]")
 @Permissive(perm = "datura.cage")
+@Completion(args = {"%player%"}, index = 0)
+@Completion(args = {"on", "off"}, index = 1)
+@Completion(args = {"[material]"}, index = 2)
 public class CageCommand extends Commander
 {
     protected CageCommand(final @NotNull JavaPlugin plugin)
@@ -44,8 +47,6 @@ public class CageCommand extends Commander
         super(plugin);
     }
 
-    @Completion(args = {"%player%"}, index = 0)
-    @Completion(args = {"on", "off"}, index = 1)
     @Subcommand(permission = "datura.cage", args = {Player.class, String.class})
     public void cagePlayer(final CommandSender sender, final Player player, final String string)
     {
@@ -62,7 +63,6 @@ public class CageCommand extends Commander
         }
     }
 
-    @Completion(args = {"[material]"}, index = 2)
     @Subcommand(permission = "datura.cage.custom", args = {Player.class, String.class, Material.class})
     public void cagePlayer(final CommandSender sender, final Player player, final String string,
                            final Material material)

Datura/src/main/java/me/totalfreedom/datura/cmd/ClearDropsCommand.java

@@ -21,6 +21,7 @@ import org.jetbrains.annotations.NotNull;
 @Info(name = "cleardrops", description = "Clears all item drops in the world" + ".", usage = "/<command>", aliases =
     {"cd", "clearitems", "ci", "wipeitems", "wi", "removedrops", "rd"})
 @Permissive(perm = "datura.cleardrops")
+@Completion(index = 0, args = {"%world%"})
 public class ClearDropsCommand extends Commander
 {
     /**
@@ -70,7 +71,6 @@ public class ClearDropsCommand extends Commander
     }
 
     @Subcommand(permission = "datura.cleardrops", args = {World.class})
-    @Completion(index = 0, args = {"%world%"})
     public void clearDrops(final CommandSender sender, final World world)
     {
         Patchwork.getInstance()

Datura/src/main/java/me/totalfreedom/datura/cmd/ClearEntitiesCommand.java

@@ -17,6 +17,7 @@ import org.jetbrains.annotations.NotNull;
 @Info(name = "clearentities", description = "Clears all entities in the world.", usage = "/<command> [world]",
     aliases = {"ew", "ce", "entitywipe", "entityclear", "ec"})
 @Permissive(perm = "datura.clearentities")
+@Completion(index = 0, args = {"%world%"})
 public class ClearEntitiesCommand extends Commander
 {
     /**
@@ -57,7 +58,6 @@ public class ClearEntitiesCommand extends Commander
     }
 
     @Subcommand(permission = "datura.clearentities", args = {World.class})
-    @Completion(index = 0, args = {"%world%"})
     public void clearEntities(final CommandSender sender, final World world)
     {
         int i = 0;

Datura/src/main/java/me/totalfreedom/datura/cmd/HaltCommand.java

@@ -17,6 +17,8 @@ import org.jetbrains.annotations.NotNull;
 
 @Info(name = "halt", description = "Halt a single player, or every player.", usage = "/<command> <player | all> <on, off>")
 @Permissive(perm = "datura.halt")
+@Completion(index = 0, args = {"%player%", "all"})
+@Completion(index = 1, args = {"on", "off"})
 public class HaltCommand extends Commander
 {
     private final Datura plugin = Shortcuts.provideModule(Datura.class);
@@ -35,9 +37,6 @@ public class HaltCommand extends Commander
         super(plugin);
     }
 
-
-    @Completion(index = 0, args = {"%player%", "all"})
-    @Completion(index = 1, args = {"on", "off"})
     @Subcommand(permission = "datura.halt", args = {Player.class, String.class})
     public void haltPlayer(final CommandSender sender, final Player target, final String toggle)
     {
@@ -58,7 +57,6 @@ public class HaltCommand extends Commander
         }
     }
 
-    // No completion needed here since it's already registered.
     @Subcommand(permission = "datura.halt.all", args = {String.class, String.class})
     public void haltAll(final CommandSender sender, final String all, final String toggle)
     {

Datura/src/main/java/me/totalfreedom/datura/cmd/LockerCommand.java

@@ -13,6 +13,8 @@ import org.jetbrains.annotations.NotNull;
 @Info(name = "locker", description = "Lock a player, preventing them from interacting with their game client.",
         usage = "/locker <player> <on|off>", aliases = {"lock", "lockup"})
 @Permissive(perm = "datura.locker")
+@Completion(args = {"%player%"}, index = 0)
+@Completion(args = {"on", "off"}, index = 1)
 public final class LockerCommand extends Commander
 {
     public LockerCommand(final @NotNull Datura plugin)
@@ -20,8 +22,6 @@ public final class LockerCommand extends Commander
         super(plugin);
     }
 
-    @Completion(args = {"%player%"}, index = 0)
-    @Completion(args = {"on", "off"}, index = 1)
     @Subcommand(permission = "datura.locker", args = {Player.class, String.class})
     public void lockPlayer(final CommandSender sender, final Player player, final String string)
     {

Datura/src/main/java/me/totalfreedom/datura/cmd/ManageUserCommand.java

@@ -20,6 +20,9 @@ import org.jetbrains.annotations.NotNull;
 @Info(name = "manageuser", description = "Manage a user's permissions", usage = "/manageuser <username> <info | (add "
     + "| remove <permission>)>", aliases = {"mu", "userdata", "ud", "usermanager", "um"})
 @Permissive(perm = "datura.manageuser")
+@Completion(index = 0, args = {"%player%"})
+@Completion(index = 1, args = {"info", "add", "remove"})
+@Completion(index = 2, args = {"<permission>"})
 public class ManageUserCommand extends Commander
 {
 
@@ -38,9 +41,6 @@ public class ManageUserCommand extends Commander
     }
 
     @Subcommand(permission = "datura.manageuser", args = {Player.class, String.class, String.class, Long.class})
-    @Completion(index = 0, args = {"%player%"})
-    @Completion(index = 1, args = {"info", "add", "remove"})
-    @Completion(index = 2, args = {"<permission>"})
     public void manageUser(final CommandSender sender, final Player player, final String addOrRemove,
                            final String permission, final long duration)
     {

Datura/src/main/java/me/totalfreedom/datura/cmd/SmiteCommand.java

@@ -13,6 +13,7 @@ import org.jetbrains.annotations.NotNull;
 
 @Info(name = "smite", description = "Smite a player.", usage = "/smite <player>", aliases = {"sm"})
 @Permissive(perm = "datura.smite")
+@Completion(index = 0, args = {"%player%"})
 public class SmiteCommand extends Commander
 {
     /**
@@ -30,7 +31,6 @@ public class SmiteCommand extends Commander
     }
 
     @Subcommand(permission = "datura.smite", args = {Player.class})
-    @Completion(index = 0, args = {"%player%"})
     public void smite(final CommandSender sender, final Player player)
     {
         final double size = 5D;

Patchwork/src/main/java/me/totalfreedom/audience/MutableAudienceForwarder.java

@@ -1,5 +1,9 @@
 package me.totalfreedom.audience;
 
+import java.util.HashSet;
+import java.util.Set;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.bossbar.BossBar;
 import net.kyori.adventure.chat.ChatType;
@@ -13,13 +17,8 @@ import net.kyori.adventure.title.Title;
 import net.kyori.adventure.title.TitlePart;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.HashSet;
-import java.util.Set;
-import java.util.function.Consumer;
-import java.util.function.Predicate;
-
 /**
- * A replacement for {@link net.kyori.adventure.audience.ForwardingAudience} that allows for audiences to be removed &
+ * A replacement for {@link net.kyori.adventure.audience.ForwardingAudience} that allows for audiences to be removed and
  * added at will. Not thread safe.
  * <p>
  * This is intended for use in toggleable logging systems, for example, potion spy.

Patchwork/src/main/java/me/totalfreedom/command/BukkitDelegate.java

@@ -1,5 +1,9 @@
 package me.totalfreedom.command;
 
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Set;
 import me.totalfreedom.command.annotation.Completion;
 import me.totalfreedom.command.annotation.Subcommand;
 import me.totalfreedom.provider.ContextProvider;
@@ -10,24 +14,18 @@ import org.bukkit.Location;
 import org.bukkit.World;
 import org.bukkit.command.Command;
 import org.bukkit.command.CommandSender;
-import org.bukkit.command.ConsoleCommandSender;
 import org.bukkit.command.PluginIdentifiableCommand;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.jetbrains.annotations.NotNull;
 
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Set;
-
 /**
  * This class is acts as a delegate between our custom command implementation and the Bukkit API.
  * <br>
  * This class is not meant to be used directly, and is only public to allow for the Bukkit API to access it. As a
  * result, this file will remain undocumented.
- * <span color=#ff0000>
+ * <br>
  * <br>
  * This class is not thread-safe.
  * <br>
@@ -36,7 +34,6 @@ import java.util.Set;
  * This class is not meant to be instantiated.
  * <br>
  * This class is not meant to be used outside Patchwork.
- * </span>
  */
 public final class BukkitDelegate extends Command implements PluginIdentifiableCommand
 {
@@ -101,14 +98,18 @@ public final class BukkitDelegate extends Command implements PluginIdentifiableC
         {
             try
             {
-                if (noConsole) {
+                if (noConsole)
+                {
                     command.getBaseMethod()
-                           .invoke(command, (Player)sender);
+                           .invoke(command, (Player) sender);
-                } else {
+                }
+                else
+                {
                     command.getBaseMethod()
                            .invoke(command, sender);
                 }
-            } catch (Exception ex)
+            }
+            catch (Exception ex)
             {
                 FreedomLogger.getLogger("Patchwork")
                              .error(ex);
@@ -142,37 +143,45 @@ public final class BukkitDelegate extends Command implements PluginIdentifiableC
                     final String[] reasonArgs = Arrays.copyOfRange(args, i, args.length - 1);
                     final String reason = String.join(" ", reasonArgs);
                     objects[i] = reason;
-                } else
+                }
+                else
                 {
                     continue;
                 }
             }
 
-            if (argType.equals(Location.class)) {
+            if (argType.equals(Location.class))
+            {
                 final String[] locationArgs = Arrays.copyOfRange(args, i, i + 3);
                 final String location = String.join(" ", locationArgs);
                 objects[i] = location;
             }
 
             final Object obj = provider.fromString(arg, argType);
-            if (obj == null) {
+            if (obj == null)
-                FreedomLogger.getLogger("Datura").error("Failed to parse argument " + arg + " for type " + argType.getName());
+            {
+                FreedomLogger.getLogger("Datura")
+                             .error("Failed to parse argument " + arg + " for type " + argType.getName());
                 return;
             }
             objects[i] = obj;
         }
         try
         {
-            if (noConsole) {
+            if (noConsole)
+            {
                 command.getSubcommands()
                        .get(node)
-                       .invoke(command, (Player)sender, objects);
+                       .invoke(command, (Player) sender, objects);
-            } else {
+            }
+            else
+            {
                 command.getSubcommands()
                        .get(node)
                        .invoke(command, sender, objects);
             }
-        } catch (Exception ex)
+        }
+        catch (Exception ex)
         {
             FreedomLogger.getLogger("Patchwork")
                          .error(ex);
@@ -204,16 +213,16 @@ public final class BukkitDelegate extends Command implements PluginIdentifiableC
                                                            .map(World::getName)
                                                            .toList());
                     case "%number%" -> results.addAll(List.of(
-                            "0",
+                        "0",
-                            "1",
+                        "1",
-                            "2",
+                        "2",
-                            "3",
+                        "3",
-                            "4",
+                        "4",
-                            "5",
+                        "5",
-                            "6",
+                        "6",
-                            "7",
+                        "7",
-                            "8",
+                        "8",
-                            "9"));
+                        "9"));
                     case "%location%" -> results.add("world x y z");
                     default -> results.add(p);
                 }

Patchwork/src/main/java/me/totalfreedom/command/annotation/Completion.java

@@ -12,7 +12,7 @@ import java.lang.annotation.Target;
  * This will register at class level, and does not retain method information. As a result, you only need to register the
  * arguments a single time, and it will always be used in tab completions.
  */
-@Target(ElementType.METHOD)
+@Target(ElementType.TYPE)
 @Repeatable(Completions.class)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Completion

Patchwork/src/main/java/me/totalfreedom/command/annotation/Completions.java

@@ -8,10 +8,10 @@ import java.lang.annotation.Target;
 /**
  * A marker interface which represents a holder for multiple {@link Completion} annotations.
  * <br>
- * <u>This interface is <span color=#ff0000><b>NOT</b></span> intended for implementation and should
+ * <u>This interface is <b>NOT</b> intended for implementation and should
- * <span color=#ff0000><b>NOT</b></span> be used.</u>
+ * <b>NOT</b> be used.</u>
  */
-@Target(ElementType.METHOD)
+@Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Completions
 {

Patchwork/src/main/java/me/totalfreedom/data/ServiceTaskRegistry.java

@@ -284,7 +284,7 @@ public class ServiceTaskRegistry
      * <br>
      * <i>The service should have been registered previously as a <b>ServiceSubscription</b></i>.
      *
-     * @param service The service you are trying to unregister.
+     * @param clazz The service you are trying to unregister.
      * @see #registerService(ServiceSubscription)
      * @see ServiceSubscription
      */

Patchwork/src/main/java/me/totalfreedom/display/DisplayableView.java

@@ -78,6 +78,7 @@ public class DisplayableView extends InventoryView
     }
 
     @Override
+    @Deprecated(forRemoval = true, since = "1.16")
     public @NotNull String getTitle()
     {
         return title;

Patchwork/src/main/java/me/totalfreedom/particle/Trail.java

@@ -56,7 +56,7 @@ public interface Trail
      *
      * @return The color of the trail, or null if the trail is a gradient or non-colorable.
      * @see Particle
-     * @see #getColors();
+     * @see #getColors()
      */
     @Nullable
     Color getColor();

Patchwork/src/main/java/me/totalfreedom/shop/Reaction.java

@@ -1,9 +1,7 @@
 package me.totalfreedom.shop;
 
-import me.totalfreedom.display.BossBarDisplay;
-import net.kyori.adventure.text.Component;
-
 import java.time.Duration;
+import net.kyori.adventure.text.Component;
 
 /**
  * Represents a chat reaction that can be performed by a player.
@@ -59,10 +57,4 @@ public abstract class Reaction implements Reactable
     {
         return reactionType;
     }
-
-    @Override
-    public BossBarDisplay getBossBarDisplay()
-    {
-
-    }
 }

build.gradle

@@ -59,6 +59,12 @@ subprojects {
             weight = 0
         }
     }
+
+    javadoc {
+        options {
+            encoding = 'UTF-8'
+        }
+    }
 }
 
 tasks.register('buildChain') {