Add interface for things that want to quit.

Allows us to pass in a sensible reference to things like the /exit
command, instead of a Main object or calling a method statically.

Change-Id: I3a794339cbf0c2052ff1d7bf377dacb6171bf1f7
Reviewed-on: http://gerrit.dmdirc.com/2662
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/LifecycleController.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright (c) 2006-2013 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;
+
+/**
+ * Provides methods that control the lifecycle of the application.
+ */
+public interface LifecycleController {
+
+    /**
+     * Quits the client nicely, with the default closing message.
+     */
+    void quit();
+
+    /**
+     * Quits the client nicely, with the default closing message.
+     *
+     * @param exitCode This is the exit code that will be returned to the
+     *                  operating system when the client exits
+     */
+    void quit(final int exitCode);
+
+    /**
+     * Quits the client nicely.
+     *
+     * @param reason The quit reason to send
+     */
+    void quit(final String reason);
+
+    /**
+     * Quits the client nicely.
+     *
+     * @param reason The quit reason to send
+     * @param exitCode This is the exit code that will be returned to the
+     *                  operating system when the client exits
+     */
+    void quit(final String reason, final int exitCode);
+
+}

src/com/dmdirc/Main.java

@@ -60,7 +60,7 @@ import java.util.TimerTask;
 /**
  * Main class, handles initialisation.
  */
-public class Main {
+public class Main implements LifecycleController {
 
     /** Feedback nag delay. */
     private final int FEEDBACK_DELAY = 30 * 60 * 1000;
@@ -128,7 +128,7 @@ public class Main {
 
         clp.applySettings();
 
-        new CommandLoader(serverManager, pluginManager)
+        new CommandLoader(this, serverManager, pluginManager)
                 .loadCommands(CommandManager.initCommandManager(IdentityManager.getIdentityManager(), serverManager));
 
         for (String service : new String[]{"ui", "tabcompletion", "parser"}) {
@@ -366,40 +366,27 @@ public class Main {
         }
     }
 
-    /**
-     * Quits the client nicely, with the default closing message.
-     */
+    /** {@inheritDoc} */
+    @Override
     public void quit() {
         quit(0);
     }
 
-    /**
-     * Quits the client nicely, with the default closing message.
-     *
-     * @param exitCode This is the exit code that will be returned to the
-     *                  operating system when the client exits
-     */
+    /** {@inheritDoc} */
+    @Override
     public void quit(final int exitCode) {
         quit(IdentityManager.getIdentityManager().getGlobalConfiguration().getOption("general",
                 "closemessage"), exitCode);
     }
 
-    /**
-     * Quits the client nicely.
-     *
-     * @param reason The quit reason to send
-     */
+    /** {@inheritDoc} */
+    @Override
     public void quit(final String reason) {
         quit(reason, 0);
     }
 
-    /**
-     * Quits the client nicely.
-     *
-     * @param reason The quit reason to send
-     * @param exitCode This is the exit code that will be returned to the
-     *                  operating system when the client exits
-     */
+    /** {@inheritDoc} */
+    @Override
     public void quit(final String reason, final int exitCode) {
         serverManager.disconnectAll(reason);
 

src/com/dmdirc/commandparser/CommandLoader.java

@@ -22,6 +22,7 @@
 
 package com.dmdirc.commandparser;
 
+import com.dmdirc.LifecycleController;
 import com.dmdirc.ServerManager;
 import com.dmdirc.commandparser.commands.channel.Ban;
 import com.dmdirc.commandparser.commands.channel.Cycle;
@@ -74,6 +75,9 @@ import com.dmdirc.plugins.PluginManager;
  */
 public class CommandLoader {
 
+    /** Controller to give to commands that want to start/stop the app. */
+    private final LifecycleController lifecycleController;
+
     /** Server manager to give to server-related commands. */
     private final ServerManager serverManager;
 
@@ -83,12 +87,15 @@ public class CommandLoader {
     /**
      * Creates a new instance of {@link CommandLoader}.
      *
+     * @param lifecycleController Controller to give to commands that want to start/stop the app.
      * @param serverManager The server manager to pass to server-related commands.
      * @param pluginManager The plugin manager to pass to plugin-dependent commands.
      */
     public CommandLoader(
+            final LifecycleController lifecycleController,
             final ServerManager serverManager,
             final PluginManager pluginManager) {
+        this.lifecycleController = lifecycleController;
         this.serverManager = serverManager;
         this.pluginManager = pluginManager;
     }
@@ -144,7 +151,7 @@ public class CommandLoader {
         manager.registerCommand(new AllServers(serverManager), AllServers.INFO);
         manager.registerCommand(new Clear(), Clear.INFO);
         manager.registerCommand(new Echo(), Echo.INFO);
-        manager.registerCommand(new Exit(), Exit.INFO);
+        manager.registerCommand(new Exit(lifecycleController), Exit.INFO);
         manager.registerCommand(new Help(), Help.INFO);
         manager.registerCommand(new Ifplugin(pluginManager), Ifplugin.INFO);
         manager.registerCommand(new NewServer(serverManager, pluginManager), NewServer.INFO);

src/com/dmdirc/commandparser/commands/global/Exit.java

@@ -23,7 +23,7 @@
 package com.dmdirc.commandparser.commands.global;
 
 import com.dmdirc.FrameContainer;
-import com.dmdirc.Main;
+import com.dmdirc.LifecycleController;
 import com.dmdirc.commandparser.BaseCommandInfo;
 import com.dmdirc.commandparser.CommandArguments;
 import com.dmdirc.commandparser.CommandInfo;
@@ -43,11 +43,23 @@ public class Exit extends Command {
             "exit [reason] - exits the client",
             CommandType.TYPE_GLOBAL);
 
+    /** The controller to use to quit the app. */
+    private final LifecycleController controller;
+
+    /**
+     * Creates a new instance of the {@link Exit} command.
+     *
+     * @param controller The controller to use to quit the app.
+     */
+    public Exit(final LifecycleController controller) {
+        this.controller = controller;
+    }
+
     /** {@inheritDoc} */
     @Override
     public void execute(final FrameContainer origin,
             final CommandArguments args, final CommandContext context) {
-        Main.mainInstance.quit(args.getArguments().length > 0 ? args.getArgumentsAsString()
+        controller.quit(args.getArguments().length > 0 ? args.getArgumentsAsString()
                 : origin.getConfigManager().getOption("general", "closemessage"));
     }
 

test/com/dmdirc/commandparser/commands/HelpTest.java

@@ -21,6 +21,7 @@
  */
 package com.dmdirc.commandparser.commands;
 
+import com.dmdirc.LifecycleController;
 import com.dmdirc.ServerManager;
 import com.dmdirc.TestMain;
 import com.dmdirc.commandparser.CommandInfo;
@@ -61,6 +62,7 @@ public class HelpTest {
 
         TestMain.getTestMain();
         new CommandLoader(
+                mock(LifecycleController.class),
                 mock(ServerManager.class),
                 mock(PluginManager.class)).loadCommands(CommandManager.getCommandManager());