Issue 1453: Initial separation of Command and CommandInfo

src/com/dmdirc/commandparser/CommandInfo.java

@@ -27,30 +27,34 @@ package com.dmdirc.commandparser;
  * 
  * @author chris
  */
-public abstract class CommandInfo {
+public interface CommandInfo {
           
     /**
      * Returns this command's name.
+     *
      * @return The name of this command
      */
-    public abstract String getName();
+    String getName();
     
     /**
      * Returns whether or not this command should be shown in help messages.
+     *
      * @return True iff the command should be shown, false otherwise
      */
-    public abstract boolean showInHelp();
+    boolean showInHelp();
     
     /**
      * Returns a string representing the help message for this command.
+     *
      * @return the help message for this command
      */
-    public abstract String getHelp();
+    String getHelp();
     
     /**
      * Retrieves the type of this command.
+     *
      * @return This command's type
      */
-    public abstract CommandType getType();
+    CommandType getType();
 
 }

src/com/dmdirc/commandparser/CommandManager.java

@@ -103,10 +103,26 @@ public final class CommandManager {
      * Registers a command with the command manager.
      * 
      * @param command The command to be registered
+     * @param info The information about the command
+     * @since 0.6.3
      */
-    public static void registerCommand(final Command command) {
+    public static void registerCommand(final Command command, final CommandInfo info) {
         registerCommand(command, true);
     }
+
+    /**
+     * Registers a command with the command manager.
+     *
+     * @deprecated Introduced for compatibility reasons. Use
+     * {@link #registerCommand(Command, CommandInfo)} instead.
+     * @param <T> The type that's being registered
+     * @param command An object that extends {@link Command} and implements
+     * {@link CommandInfo} to be registered.
+     * @since 0.6.3
+     */
+    public static <T extends Command & CommandInfo> void registerCommand(final T command) {
+        registerCommand(command, command);
+    }
     
     /**
      * Unregisters a command with the command manager.
@@ -170,7 +186,7 @@ public final class CommandManager {
         
         for (CommandParser parser : parsers) {
             if (register) {
-                parser.registerCommand(command);
+                parser.registerCommand(command, command);
             } else {
                 parser.unregisterCommand(command);
             }
@@ -317,11 +333,11 @@ public final class CommandManager {
      */
     public static void loadChannelCommands(final CommandParser parser) {
         for (Command com : getCommands(CommandType.TYPE_CHANNEL, null)) {
-            parser.registerCommand(com);
+            parser.registerCommand(com, com);
         }
         
         for (Command com : getCommands(CommandType.TYPE_CHAT, null)) {
-            parser.registerCommand(com);
+            parser.registerCommand(com, com);
         }
         
         parsers.add(CommandType.TYPE_CHANNEL, parser);
@@ -334,7 +350,7 @@ public final class CommandManager {
      */
     public static void loadServerCommands(final CommandParser parser) {
         for (Command command : getCommands(CommandType.TYPE_SERVER, null)) {
-            parser.registerCommand(command);
+            parser.registerCommand(command, command);
         }
         
         parsers.add(CommandType.TYPE_SERVER, parser);
@@ -347,7 +363,7 @@ public final class CommandManager {
      */
     public static void loadGlobalCommands(final CommandParser parser) {
         for (Command com : getCommands(CommandType.TYPE_GLOBAL, null)) {
-            parser.registerCommand(com);
+            parser.registerCommand(com, com);
         }
         
         parsers.add(CommandType.TYPE_GLOBAL, parser);
@@ -360,11 +376,11 @@ public final class CommandManager {
      */
     public static void loadQueryCommands(final CommandParser parser) {
         for (Command com : getCommands(CommandType.TYPE_QUERY, null)) {
-            parser.registerCommand(com);
+            parser.registerCommand(com, com);
         }
         
         for (Command com : getCommands(CommandType.TYPE_CHAT, null)) {
-            parser.registerCommand(com);
+            parser.registerCommand(com, com);
         }
         
         parsers.add(CommandType.TYPE_QUERY, parser);

src/com/dmdirc/commandparser/commands/Command.java

@@ -30,9 +30,10 @@ import com.dmdirc.ui.messages.Styliser;
 
 /**
  * Represents a generic command.
+ *
  * @author chris
  */
-public abstract class Command extends CommandInfo implements Comparable<Command> {
+public abstract class Command implements CommandInfo, Comparable<Command> {
     
     /** The format name used for command output. */
     protected static final String FORMAT_OUTPUT = "commandOutput";

src/com/dmdirc/commandparser/parsers/ChannelCommandParser.java

@@ -67,7 +67,8 @@ public final class ChannelCommandParser extends CommandParser {
         this.channel = newChannel;
     }
     
-    /** Loads the relevant commands into the parser. */
+    /** {@inheritDoc} */
+    @Override
     protected void loadCommands() {
         CommandManager.loadGlobalCommands(this);
         CommandManager.loadServerCommands(this);
@@ -75,6 +76,7 @@ public final class ChannelCommandParser extends CommandParser {
     }
     
     /** {@inheritDoc} */
+    @Override
     protected void executeCommand(final InputWindow origin,
             final boolean isSilent, final Command command, final String... args) {
         if (command instanceof ChannelCommand) {
@@ -91,9 +93,11 @@ public final class ChannelCommandParser extends CommandParser {
     /**
      * Called when the input was a line of text that was not a command. This normally
      * means it is sent to the server/channel/user as-is, with no further processing.
+     *
      * @param origin The window in which the command was typed
      * @param line The line input by the user
      */
+    @Override
     protected void handleNonCommand(final InputWindow origin, final String line) {
         channel.sendLine(line);
     }

src/com/dmdirc/commandparser/parsers/CommandParser.java

@@ -25,6 +25,7 @@ package com.dmdirc.commandparser.parsers;
 import com.dmdirc.Server;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.commandparser.CommandInfo;
 import com.dmdirc.commandparser.CommandManager;
 import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.commands.Command;
@@ -79,19 +80,22 @@ public abstract class CommandParser implements Serializable {
     /**
      * Registers the specified command with this parser.
      *
+     * @since 0.6.3
      * @param command Command to be registered
+     * @param info The information the command should be registered with
      */
-    public final void registerCommand(final Command command) {
-        commands.put(command.getName().toLowerCase(), command);
+    public final void registerCommand(final Command command, final CommandInfo info) {
+        commands.put(info.getName().toLowerCase(), command);
     }
 
     /**
      * Unregisters the specified command with this parser.
      *
-     * @param command Command to be unregistered
+     * @param info Command information to be unregistered
+     * @since 0.6.3
      */
-    public final void unregisterCommand(final Command command) {
-        commands.remove(command.getName().toLowerCase());
+    public final void unregisterCommand(final CommandInfo info) {
+        commands.remove(info.getName().toLowerCase());
     }
 
     /**

src/com/dmdirc/commandparser/parsers/GlobalCommandParser.java

@@ -67,11 +67,13 @@ public final class GlobalCommandParser extends CommandParser {
     }
     
     /** Loads the relevant commands into the parser. */
+    @Override
     protected void loadCommands() {
         CommandManager.loadGlobalCommands(this);
     }
     
     /** {@inheritDoc} */
+    @Override
     protected void executeCommand(final InputWindow origin,
             final boolean isSilent, final Command command, final String... args) {
         ((GlobalCommand) command).execute(origin, isSilent, args);
@@ -83,6 +85,7 @@ public final class GlobalCommandParser extends CommandParser {
      * @param origin The window in which the command was typed
      * @param line The line input by the user
      */
+    @Override
     protected void handleNonCommand(final InputWindow origin, final String line) {
         if (origin == null) {
             Logger.userError(ErrorLevel.MEDIUM, "Invalid global command: " + line);

src/com/dmdirc/commandparser/parsers/QueryCommandParser.java

@@ -68,6 +68,7 @@ public final class QueryCommandParser extends CommandParser {
     }
     
     /** Loads the relevant commands into the parser. */
+    @Override
     protected void loadCommands() {
         CommandManager.loadGlobalCommands(this);
         CommandManager.loadServerCommands(this);
@@ -75,6 +76,7 @@ public final class QueryCommandParser extends CommandParser {
     }
     
     /** {@inheritDoc} */
+    @Override
     protected void executeCommand(final InputWindow origin,
             final boolean isSilent, final Command command, final String... args) {
         if (command instanceof QueryCommand) {
@@ -94,6 +96,7 @@ public final class QueryCommandParser extends CommandParser {
      * @param origin The window in which the command was typed
      * @param line The line input by the user
      */
+    @Override
     protected void handleNonCommand(final InputWindow origin, final String line) {
         query.sendLine(line);
     }

src/com/dmdirc/commandparser/parsers/ServerCommandParser.java

@@ -58,12 +58,14 @@ public final class ServerCommandParser extends CommandParser {
     }
     
     /** Loads the relevant commands into the parser. */
+    @Override
     protected void loadCommands() {
         CommandManager.loadGlobalCommands(this);
         CommandManager.loadServerCommands(this);
     }
     
     /** {@inheritDoc} */
+    @Override
     protected void executeCommand(final InputWindow origin,
             final boolean isSilent, final Command command, final String... args) {
         if (command instanceof ServerCommand) {
@@ -79,6 +81,7 @@ public final class ServerCommandParser extends CommandParser {
      * @param origin The window in which the command was typed
      * @param line The line input by the user
      */
+    @Override
     protected void handleNonCommand(final InputWindow origin, final String line) {
         server.sendLine(line);
     }