Renamed CommandRegistry to Commands

as discussed in CR

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/Application.java

@@ -4,6 +4,7 @@
 import net.dv8tion.jda.api.JDABuilder;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.togetherjava.tjbot.commands.Commands;
 import org.togetherjava.tjbot.commands.system.CommandSystem;
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.db.Database;
@@ -19,7 +20,7 @@
  * New commands can be created by implementing
  * {@link net.dv8tion.jda.api.events.interaction.SlashCommandEvent} or extending
  * {@link org.togetherjava.tjbot.commands.SlashCommandAdapter}. They can then be registered in
- * {@link org.togetherjava.tjbot.commands.CommandRegistry}.
+ * {@link Commands}.
  */
 public enum Application {
     ;

…java/tjbot/commands/CommandRegistry.java …ogetherjava/tjbot/commands/Commands.javaapplication/src/main/java/org/togetherjava/tjbot/commands/CommandRegistry.java renamed to application/src/main/java/org/togetherjava/tjbot/commands/Commands.java application/src/main/java/org/togetherjava/tjbot/commands/CommandRegistry.java renamed to application/src/main/java/org/togetherjava/tjbot/commands/Commands.java

@@ -9,14 +9,14 @@
 import java.util.List;
 
 /**
- * Utility class that offers all registered commands. New commands have to be added here, where
- * {@link org.togetherjava.tjbot.commands.system.CommandSystem} will then pick it up from and
- * register it with the system.
+ * Utility class that offers all commands that should be registered by the system. New commands have
+ * to be added here, where {@link org.togetherjava.tjbot.commands.system.CommandSystem} will then
+ * pick it up from and register it with the system.
  * <p>
  * To add a new slash command, extend the commands returned by
  * {@link #createSlashCommands(Database)}.
  */
-public enum CommandRegistry {
+public enum Commands {
     ;
 
     /**
@@ -30,6 +30,9 @@ public enum CommandRegistry {
      */
     public static @NotNull Collection<SlashCommand> createSlashCommands(
             @NotNull Database database) {
+        // NOTE The command system can add special system relevant commands also by itself,
+        // hence this list may not necessarily represent the full list of all commands actually
+        // available.
         return List.of(new PingCommand(), new DatabaseCommand(database));
     }
 }

application/src/main/java/org/togetherjava/tjbot/commands/SlashCommand.java

@@ -17,7 +17,7 @@
  * <p>
  * All slash commands have to implement this interface. For convenience, there is a
  * {@link SlashCommandAdapter} available that implemented most methods already. A new command can
- * then be registered by adding it to {@link CommandRegistry}.
+ * then be registered by adding it to {@link Commands}.
  * <p>
  * <p>
  * Slash commands can either be visible globally in Discord or just to specific guilds. They can

application/src/main/java/org/togetherjava/tjbot/commands/SlashCommandAdapter.java

@@ -14,7 +14,7 @@
 /**
  * Adapter implementation of a {@link SlashCommand}. The minimal setup only requires implementation
  * of {@link #onSlashCommand(SlashCommandEvent)}. A new command can then be registered by adding it
- * to {@link CommandRegistry}.
+ * to {@link Commands}.
  * <p>
  * Further, {@link #onButtonClick(ButtonClickEvent, List)} and
  * {@link #onSelectionMenu(SelectionMenuEvent, List)} can be overridden if desired. The default
@@ -51,7 +51,7 @@
  * }
  * </pre>
  * 
- * and registration of an instance of that class in {@link CommandRegistry}.
+ * and registration of an instance of that class in {@link Commands}.
  */
 public abstract class SlashCommandAdapter implements SlashCommand {
     private final String name;

application/src/main/java/org/togetherjava/tjbot/commands/package-info.java

@@ -2,8 +2,8 @@
  * This package contains the command system and most commands of the bot. Commands can also be
  * created in different modules, if desired.
  * <p>
- * Commands are registered in {@link org.togetherjava.tjbot.commands.CommandRegistry} and then
- * picked up by the {@link org.togetherjava.tjbot.commands.system.CommandSystem}.
+ * Commands are registered in {@link org.togetherjava.tjbot.commands.Commands} and then picked up by
+ * the {@link org.togetherjava.tjbot.commands.system.CommandSystem}.
  * <p>
  * Custom slash commands can be created by implementing
  * {@link org.togetherjava.tjbot.commands.SlashCommand} or using the adapter

application/src/main/java/org/togetherjava/tjbot/commands/system/CommandSystem.java

@@ -12,7 +12,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.togetherjava.tjbot.commands.CommandRegistry;
+import org.togetherjava.tjbot.commands.Commands;
 import org.togetherjava.tjbot.commands.SlashCommand;
 import org.togetherjava.tjbot.db.Database;
 
@@ -28,9 +28,9 @@
  * of event parsing.
  * <p>
  * <p>
- * Commands are made available via {@link CommandRegistry}, then the system has to be added to JDA
- * as an event listener, using {@link net.dv8tion.jda.api.JDA#addEventListener(Object...)}.
- * Afterwards, the system is ready and will correctly forward events to all commands.
+ * Commands are made available via {@link Commands}, then the system has to be added to JDA as an
+ * event listener, using {@link net.dv8tion.jda.api.JDA#addEventListener(Object...)}. Afterwards,
+ * the system is ready and will correctly forward events to all commands.
  */
 public final class CommandSystem extends ListenerAdapter implements SlashCommandProvider {
     private static final Logger logger = LoggerFactory.getLogger(CommandSystem.class);
@@ -40,13 +40,13 @@ public final class CommandSystem extends ListenerAdapter implements SlashCommand
     /**
      * Creates a new command system which uses the given database to allow commands to persist data.
      * <p>
-     * Commands are fetched from {@link CommandRegistry}.
+     * Commands are fetched from {@link Commands}.
      *
      * @param database the database that commands may use to persist data
      */
     @SuppressWarnings("ThisEscapedInObjectConstruction")
     public CommandSystem(@NotNull Database database) {
-        nameToSlashCommands = CommandRegistry.createSlashCommands(database)
+        nameToSlashCommands = Commands.createSlashCommands(database)
             .stream()
             .collect(Collectors.toMap(SlashCommand::getName, Function.identity()));