Rename Command to BaseCommand.

Command will eventually become an interface when all usages have been replaced

src/main/java/com/dmdirc/commandparser/commands/BaseCommand.java

@@ -0,0 +1,162 @@
+/*
+ * Copyright (c) 2006-2015 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.commandparser.commands;
+
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.events.CommandErrorEvent;
+import com.dmdirc.events.CommandOutputEvent;
+import com.dmdirc.interfaces.CommandController;
+import com.dmdirc.interfaces.WindowModel;
+import com.dmdirc.ui.messages.IRCControlCodes;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+/**
+ * Represents a generic command.
+ */
+public abstract class BaseCommand {
+
+    /** The controller this command is associated with. */
+    private final CommandController controller;
+
+    public BaseCommand(final CommandController controller) {
+        this.controller = controller;
+    }
+
+    protected CommandController getController() {
+        return controller;
+    }
+
+    /**
+     * Sends an output line, if appropriate, to the specified target.
+     *
+     * @param target   The command window to send the line to
+     * @param isSilent Whether this command is being silenced or not
+     * @param message  The output to send
+     */
+    protected final void showOutput(@Nullable final WindowModel target,
+            final boolean isSilent, final String message) {
+        if (!isSilent && target != null) {
+            target.getEventBus().publishAsync(new CommandOutputEvent(target, message));
+        }
+    }
+
+    /**
+     * Sends an error line, if appropriate, to the specified target.
+     *
+     * @param target   The command window to send the line to
+     * @param isSilent Whether this command is being silenced or not
+     * @param message  The error message to send
+     */
+    protected final void showError(@Nullable final WindowModel target,
+            final boolean isSilent, final String message) {
+        if (!isSilent && target != null) {
+            target.getEventBus().publishAsync(new CommandErrorEvent(target, message));
+        }
+    }
+
+    /**
+     * Sends a usage line, if appropriate, to the specified target.
+     *
+     * @param target   The command window to send the line to
+     * @param isSilent Whether this command is being silenced or not
+     * @param name     The name of the command that's raising the error
+     * @param args     The arguments that the command accepts or expects
+     */
+    protected final void showUsage(@Nullable final WindowModel target,
+            final boolean isSilent, final String name, final String args) {
+        if (!isSilent && target != null) {
+            target.getEventBus().publishAsync(new CommandErrorEvent(target,
+                    "Usage: " + controller.getCommandChar() + name + ' ' + args));
+        }
+    }
+
+    /**
+     * Formats the specified data into a table suitable for output in the textpane. It is expected
+     * that each String[] in data has the same number of elements as the headers array.
+     *
+     * @param headers The headers of the table.
+     * @param data    The contents of the table.
+     *
+     * @return A string containing an ASCII table
+     */
+    protected static String doTable(final String[] headers, final String[][] data) {
+        final StringBuilder res = new StringBuilder();
+        res.append(IRCControlCodes.FIXED);
+        res.append(IRCControlCodes.BOLD);
+
+        final int[] maxsizes = new int[headers.length];
+
+        for (int i = 0; i < headers.length; i++) {
+            maxsizes[i] = headers[i].length() + 3;
+
+            for (String[] row : data) {
+                maxsizes[i] = Math.max(maxsizes[i], row[i].length() + 3);
+            }
+
+            doPadding(res, headers[i], maxsizes[i]);
+        }
+
+        for (String[] source : data) {
+            res.append('\n');
+            res.append(IRCControlCodes.FIXED);
+
+            for (int i = 0; i < source.length; i++) {
+                doPadding(res, source[i], maxsizes[i]);
+            }
+        }
+
+        return res.toString();
+    }
+
+    /**
+     * Adds the specified data to the stringbuilder, padding with spaces to the specified size.
+     *
+     * @param builder The stringbuilder to append data to
+     * @param data    The data to be added
+     * @param size    The minimum size that should be used
+     */
+    private static void doPadding(final StringBuilder builder, final String data,
+            final int size) {
+        builder.append(data);
+
+        for (int i = 0; i < size - data.length(); i++) {
+            builder.append(' ');
+        }
+    }
+
+    /**
+     * Executes this command.
+     *
+     * @param origin  The container which received the command
+     * @param args    Arguments passed to this command
+     * @param context The context the command was executed in
+     *
+     * @since 0.6.4
+     */
+    public abstract void execute(@Nonnull WindowModel origin, CommandArguments args,
+            CommandContext context);
+
+}

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

@@ -1,162 +1,15 @@
-/*
- * Copyright (c) 2006-2015 DMDirc Developers
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
 package com.dmdirc.commandparser.commands;
 
-import com.dmdirc.commandparser.CommandArguments;
-import com.dmdirc.commandparser.commands.context.CommandContext;
-import com.dmdirc.events.CommandErrorEvent;
-import com.dmdirc.events.CommandOutputEvent;
 import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.WindowModel;
-import com.dmdirc.ui.messages.IRCControlCodes;
-
-import javax.annotation.Nonnull;
-import javax.annotation.Nullable;
 
 /**
- * Represents a generic command.
+ * @deprecated Use {@link BaseCommand} directly.
  */
-public abstract class Command {
-
-    /** The controller this command is associated with. */
-    private final CommandController controller;
+@Deprecated
+public abstract class Command extends BaseCommand {
 
-    public Command(final CommandController controller) {
-        this.controller = controller;
+    public Command(CommandController controller) {
+        super(controller);
     }
 
-    protected CommandController getController() {
-        return controller;
-    }
-
-    /**
-     * Sends an output line, if appropriate, to the specified target.
-     *
-     * @param target   The command window to send the line to
-     * @param isSilent Whether this command is being silenced or not
-     * @param message  The output to send
-     */
-    protected final void showOutput(@Nullable final WindowModel target,
-            final boolean isSilent, final String message) {
-        if (!isSilent && target != null) {
-            target.getEventBus().publishAsync(new CommandOutputEvent(target, message));
-        }
-    }
-
-    /**
-     * Sends an error line, if appropriate, to the specified target.
-     *
-     * @param target   The command window to send the line to
-     * @param isSilent Whether this command is being silenced or not
-     * @param message  The error message to send
-     */
-    protected final void showError(@Nullable final WindowModel target,
-            final boolean isSilent, final String message) {
-        if (!isSilent && target != null) {
-            target.getEventBus().publishAsync(new CommandErrorEvent(target, message));
-        }
-    }
-
-    /**
-     * Sends a usage line, if appropriate, to the specified target.
-     *
-     * @param target   The command window to send the line to
-     * @param isSilent Whether this command is being silenced or not
-     * @param name     The name of the command that's raising the error
-     * @param args     The arguments that the command accepts or expects
-     */
-    protected final void showUsage(@Nullable final WindowModel target,
-            final boolean isSilent, final String name, final String args) {
-        if (!isSilent && target != null) {
-            target.getEventBus().publishAsync(new CommandErrorEvent(target,
-                    "Usage: " + controller.getCommandChar() + name + ' ' + args));
-        }
-    }
-
-    /**
-     * Formats the specified data into a table suitable for output in the textpane. It is expected
-     * that each String[] in data has the same number of elements as the headers array.
-     *
-     * @param headers The headers of the table.
-     * @param data    The contents of the table.
-     *
-     * @return A string containing an ASCII table
-     */
-    protected static String doTable(final String[] headers, final String[][] data) {
-        final StringBuilder res = new StringBuilder();
-        res.append(IRCControlCodes.FIXED);
-        res.append(IRCControlCodes.BOLD);
-
-        final int[] maxsizes = new int[headers.length];
-
-        for (int i = 0; i < headers.length; i++) {
-            maxsizes[i] = headers[i].length() + 3;
-
-            for (String[] row : data) {
-                maxsizes[i] = Math.max(maxsizes[i], row[i].length() + 3);
-            }
-
-            doPadding(res, headers[i], maxsizes[i]);
-        }
-
-        for (String[] source : data) {
-            res.append('\n');
-            res.append(IRCControlCodes.FIXED);
-
-            for (int i = 0; i < source.length; i++) {
-                doPadding(res, source[i], maxsizes[i]);
-            }
-        }
-
-        return res.toString();
-    }
-
-    /**
-     * Adds the specified data to the stringbuilder, padding with spaces to the specified size.
-     *
-     * @param builder The stringbuilder to append data to
-     * @param data    The data to be added
-     * @param size    The minimum size that should be used
-     */
-    private static void doPadding(final StringBuilder builder, final String data,
-            final int size) {
-        builder.append(data);
-
-        for (int i = 0; i < size - data.length(); i++) {
-            builder.append(' ');
-        }
-    }
-
-    /**
-     * Executes this command.
-     *
-     * @param origin  The container which received the command
-     * @param args    Arguments passed to this command
-     * @param context The context the command was executed in
-     *
-     * @since 0.6.4
-     */
-    public abstract void execute(@Nonnull WindowModel origin, CommandArguments args,
-            CommandContext context);
-
 }