Introduce an event bus.

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

src/com/dmdirc/ClientModule.java

@@ -60,11 +60,15 @@ import com.dmdirc.updater.UpdaterModule;
 import com.dmdirc.updater.Version;
 import com.dmdirc.updater.manager.UpdateManager;
 
+import com.google.common.eventbus.AsyncEventBus;
+import com.google.common.eventbus.EventBus;
+
 import java.awt.GraphicsEnvironment;
 import java.io.File;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Set;
+import java.util.concurrent.Executors;
 
 import javax.inject.Provider;
 import javax.inject.Qualifier;
@@ -398,6 +402,17 @@ public class ClientModule {
         return identityManager;
     }
 
+    /**
+     * Provides the event bus the client will use for dispatching events.
+     *
+     * @return An event bus for the client to use.
+     */
+    @Provides
+    @Singleton
+    public EventBus getEventBus() {
+        return new AsyncEventBus(Executors.newFixedThreadPool(1));
+    }
+
     /**
      * Sets the object graph that will be injected. Must be called before any provider method.
      *

src/com/dmdirc/Main.java

@@ -28,6 +28,7 @@ import com.dmdirc.actions.ColourActionComparison;
 import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.commandline.CommandLineParser;
 import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.events.ClientOpenedEvent;
 import com.dmdirc.interfaces.CommandController.CommandDetails;
 import com.dmdirc.interfaces.config.IdentityController;
 import com.dmdirc.interfaces.ui.UIController;
@@ -42,6 +43,8 @@ import com.dmdirc.ui.WarningDialog;
 import com.dmdirc.ui.themes.ThemeManager;
 import com.dmdirc.util.URLBuilder;
 
+import com.google.common.eventbus.EventBus;
+
 import java.awt.GraphicsEnvironment;
 import java.util.Collection;
 import java.util.HashSet;
@@ -92,6 +95,9 @@ public class Main {
     /** The colour-based action comparisons. */
     private final ColourActionComparison colourActionComparison;
 
+    /** The event bus to dispatch events on. */
+    private final EventBus eventBus;
+
     /** The commands to load into the command manager. */
     private final Set<CommandDetails> commands;
 
@@ -110,6 +116,7 @@ public class Main {
      * @param urlBuilder URL builder to use as a singleton.
      * @param globalWindowManager Global window manager to use.
      * @param colourActionComparison The colour-based action comparisons.
+     * @param eventBus The event bus to dispatch events on.
      * @param commands The commands to be loaded into the command manager.
      */
     @Inject
@@ -126,6 +133,7 @@ public class Main {
             final URLBuilder urlBuilder,
             final GlobalWindowManager globalWindowManager,
             final ColourActionComparison colourActionComparison,
+            final EventBus eventBus,
             final Set<CommandDetails> commands) {
         this.identityManager = identityManager;
         this.serverManager = serverManager;
@@ -136,6 +144,7 @@ public class Main {
         this.commandManager = commandManager;
         this.globalWindowManager = globalWindowManager;
         this.colourActionComparison = colourActionComparison;
+        this.eventBus = eventBus;
         this.commands = commands;
         URLBuilder.setInstance(urlBuilder);
     }
@@ -179,6 +188,7 @@ public class Main {
         pluginManager.doAutoLoad();
         actionManager.loadUserActions();
         actionManager.triggerEvent(CoreActionType.CLIENT_OPENED, null);
+        eventBus.post(new ClientOpenedEvent());
 
         commandLineParser.processArguments(serverManager);
 

src/com/dmdirc/events/ClientOpenedEvent.java

@@ -0,0 +1,30 @@
+/*
+ * 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.events;
+
+/**
+ * Fired when the client is first opened.
+ */
+public class ClientOpenedEvent extends DMDircEvent {
+
+}

src/com/dmdirc/events/DMDircEvent.java

@@ -0,0 +1,55 @@
+/*
+ * 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.events;
+
+import lombok.Getter;
+
+/**
+ * Base class for all DMDirc events.
+ */
+@SuppressWarnings("PMD.UnusedPrivateField")
+public abstract class DMDircEvent {
+
+    /**
+     * The timestamp the event was triggered at, in milliseconds.
+     */
+    @Getter
+    private final long timestamp;
+
+    /**
+     * Creates a new event with the specified timestamp.
+     *
+     * @param timestamp The timestamp the event was triggered at, in milliseconds.
+     */
+    public DMDircEvent(final long timestamp) {
+        this.timestamp = timestamp;
+    }
+
+    /**
+     * Creates a new event with the current system timestamp.
+     */
+    public DMDircEvent() {
+        this.timestamp = System.currentTimeMillis();
+    }
+
+}