Add dynamically asynchronous eventbus.

If an event is posted with a @AsyncEvent annotation, it will
be posted in a separate thread.

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

src/com/dmdirc/ClientModule.java

@@ -61,6 +61,7 @@ import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.themes.ThemeManager;
 import com.dmdirc.updater.UpdaterModule;
 import com.dmdirc.updater.manager.UpdateManager;
+import com.dmdirc.util.DynamicAsyncEventBus;
 import com.dmdirc.util.URLBuilder;
 import com.dmdirc.util.io.Downloader;
 
@@ -71,6 +72,7 @@ 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;
@@ -287,7 +289,7 @@ public class ClientModule {
     @Provides
     @Singleton
     public EventBus getEventBus() {
-        return new EventBus();
+        return new DynamicAsyncEventBus(Executors.newSingleThreadExecutor());
     }
 
     @Provides

src/com/dmdirc/events/ActionCreatedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.actions.Action;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired on the creation of an action.
  */
+@AsyncEvent
 public class ActionCreatedEvent extends ActionEvent {
 
     public ActionCreatedEvent(final Action action) {

src/com/dmdirc/events/ActionDeletedEvent.java

@@ -24,10 +24,12 @@ package com.dmdirc.events;
 
 import com.dmdirc.actions.Action;
 import com.dmdirc.actions.ActionGroup;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when an action is deleted.
  */
+@AsyncEvent
 public class ActionDeletedEvent extends ActionEvent {
 
     private final ActionGroup group;

src/com/dmdirc/events/ActionUpdatedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.actions.Action;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when an action is updated.
  */
+@AsyncEvent
 public class ActionUpdatedEvent extends ActionEvent {
 
     public ActionUpdatedEvent(final Action action) {

src/com/dmdirc/events/AppErrorEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Event class for app errors.
  */
+@AsyncEvent
 public class AppErrorEvent extends ErrorEvent {
 
     public AppErrorEvent(final ErrorLevel level, final Throwable throwable, final String message,

src/com/dmdirc/events/ChannelGotnamesEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.Channel;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a channel names event is received.
  */
+@AsyncEvent
 public class ChannelGotnamesEvent extends ChannelEvent {
 
     public ChannelGotnamesEvent(final long timestamp, final Channel channel) {

src/com/dmdirc/events/ClientClosedEvent.java

@@ -22,9 +22,12 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the client is being closed.
  */
+@AsyncEvent
 public class ClientClosedEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/ClientClosingEvent.java

@@ -22,9 +22,12 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the client is about to close.
  */
+@AsyncEvent
 public class ClientClosingEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/ClientFocusGainedEvent.java

@@ -22,11 +22,14 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the the client is bought into focus.
  *
  * TODO: This should be moved into the Swing UI once the corresponding action types are removed.
  */
+@AsyncEvent
 public class ClientFocusGainedEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/ClientFocusLostEvent.java

@@ -22,11 +22,14 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the the client loses focus.
  *
  * TODO: This should be moved into the Swing UI once the corresponding action types are removed.
  */
+@AsyncEvent
 public class ClientFocusLostEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/ClientFrameChangedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Event fired when a new frame has been focused.
  */
+@AsyncEvent
 public class ClientFrameChangedEvent extends DMDircEvent {
 
     private final FrameContainer container;

src/com/dmdirc/events/ClientKeyPressedEvent.java

@@ -22,6 +22,8 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 import javax.swing.KeyStroke;
 
 /**
@@ -29,6 +31,7 @@ import javax.swing.KeyStroke;
  *
  * TODO: This should be moved into the Swing UI once the corresponding action types are removed.
  */
+@AsyncEvent
 public class ClientKeyPressedEvent extends DMDircEvent {
 
     private final KeyStroke keyStroke;

src/com/dmdirc/events/ClientLineAddedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Event fired when a line has been added to a window.
  */
+@AsyncEvent
 public class ClientLineAddedEvent extends DMDircEvent {
 
     private final FrameContainer container;

src/com/dmdirc/events/ClientMinimisedEvent.java

@@ -22,11 +22,14 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the the client is minimised.
  *
  * TODO: This should be moved into the Swing UI once the corresponding action types are removed.
  */
+@AsyncEvent
 public class ClientMinimisedEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/ClientOpenedEvent.java

@@ -22,8 +22,11 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the client is first opened.
  */
+@AsyncEvent
 public class ClientOpenedEvent extends DMDircEvent {
 }

src/com/dmdirc/events/ClientPopupGeneratedEvent.java

@@ -25,10 +25,12 @@ package com.dmdirc.events;
 import com.dmdirc.commandparser.PopupMenu;
 import com.dmdirc.commandparser.PopupType;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Raised when a popup is being generated.
  */
+@AsyncEvent
 public class ClientPopupGeneratedEvent extends DMDircEvent {
 
     private final PopupType type;

src/com/dmdirc/events/ClientPrefsClosedEvent.java

@@ -22,9 +22,12 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Raised when the preferences dialog is closed.
  */
+@AsyncEvent
 public class ClientPrefsClosedEvent extends PreferencesEvent {
 
 }

src/com/dmdirc/events/ClientPrefsOpenedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.config.prefs.PreferencesDialogModel;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Raised when the preferences dialog is opened.
  */
+@AsyncEvent
 public class ClientPrefsOpenedEvent extends PreferencesEvent {
 
     private final PreferencesDialogModel model;

src/com/dmdirc/events/ClientUnminimisedEvent.java

@@ -22,11 +22,14 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the the client is unminimised.
  *
  * TODO: This should be moved into the Swing UI once the corresponding action types are removed.
  */
+@AsyncEvent
 public class ClientUnminimisedEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/ClientUserInputEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Event fired when some input has been entered into the client.
  */
+@AsyncEvent
 public class ClientUserInputEvent extends DMDircEvent {
 
     private final FrameContainer container;

src/com/dmdirc/events/FeedbackNagEvent.java

@@ -22,9 +22,12 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when its time to nag for feedback.
  */
+@AsyncEvent
 public class FeedbackNagEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/FrameChangedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Base class for all frame info events.
  */
+@AsyncEvent
 public class FrameChangedEvent extends DMDircEvent {
 
     private final FrameContainer container;

src/com/dmdirc/events/FrameIconChangedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a frame icon changes.
  */
+@AsyncEvent
 public class FrameIconChangedEvent extends FrameChangedEvent {
 
     private final String icon;

src/com/dmdirc/events/FrameNameChangedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a frame's name changes.
  */
+@AsyncEvent
 public class FrameNameChangedEvent extends FrameChangedEvent {
 
     private final String name;

src/com/dmdirc/events/FrameTitleChangedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a frame title changes.
  */
+@AsyncEvent
 public class FrameTitleChangedEvent extends FrameChangedEvent {
 
     private final String title;

src/com/dmdirc/events/LinkChannelClickedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.interfaces.ui.Window;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Raised when a channel link has been clicked.
  */
+@AsyncEvent
 public class LinkChannelClickedEvent extends LinkEvent {
 
     public LinkChannelClickedEvent(final Window window, final String target) {

src/com/dmdirc/events/LinkNicknameClickedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.interfaces.ui.Window;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Raised when a nickname link has been clicked.
  */
+@AsyncEvent
 public class LinkNicknameClickedEvent extends LinkEvent {
 
     public LinkNicknameClickedEvent(final Window window, final String target) {

src/com/dmdirc/events/LinkUrlClickedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.interfaces.ui.Window;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Raised when a URL link has been clicked.
  */
+@AsyncEvent
 public class LinkUrlClickedEvent extends LinkEvent {
 
     public LinkUrlClickedEvent(final Window window, final String target) {

src/com/dmdirc/events/PluginLoadedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a plugin is loaded.
  */
+@AsyncEvent
 public class PluginLoadedEvent extends PluginEvent {
 
     public PluginLoadedEvent(final PluginInfo plugin) {

src/com/dmdirc/events/PluginRefreshEvent.java

@@ -22,9 +22,12 @@
 
 package com.dmdirc.events;
 
+import com.dmdirc.util.AsyncEvent;
+
 /**
  * Fired when the list of available plugins may have updated.
  */
+@AsyncEvent
 public class PluginRefreshEvent extends DMDircEvent {
 
 }

src/com/dmdirc/events/PluginUnloadedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a plugin is loaded.
  */
+@AsyncEvent
 public class PluginUnloadedEvent extends PluginEvent {
 
     public PluginUnloadedEvent(final PluginInfo plugin) {

src/com/dmdirc/events/QueryClosedEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.Query;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when a query window is closed.
  */
+@AsyncEvent
 public class QueryClosedEvent extends QueryEvent {
 
     public QueryClosedEvent(final long timestamp, final Query query) {

src/com/dmdirc/events/ServerGotpingEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.interfaces.Connection;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when we receive a server ping reply.
  */
+@AsyncEvent
 public class ServerGotpingEvent extends ServerEvent {
 
     private final long ping;

src/com/dmdirc/events/ServerNopingEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.interfaces.Connection;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when we miss a server ping reply.
  */
+@AsyncEvent
 public class ServerNopingEvent extends ServerEvent {
 
     private final long ping;

src/com/dmdirc/events/ServerPingsentEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.interfaces.Connection;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Fired when sending a server ping request.
  */
+@AsyncEvent
 public class ServerPingsentEvent extends ServerEvent {
 
     public ServerPingsentEvent(final long timestamp, final Connection connection) {

src/com/dmdirc/events/UserErrorEvent.java

@@ -23,10 +23,12 @@
 package com.dmdirc.events;
 
 import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.util.AsyncEvent;
 
 /**
  * Event class for user errors.
  */
+@AsyncEvent
 public class UserErrorEvent extends ErrorEvent {
 
     public UserErrorEvent(final ErrorLevel level, final Throwable throwable, final String message,

src/com/dmdirc/events/ChanelNotopicEvent.java → src/com/dmdirc/util/AsyncEvent.java

@@ -20,21 +20,18 @@
  * SOFTWARE.
  */
 
-package com.dmdirc.events;
+package com.dmdirc.util;
 
-import com.dmdirc.Channel;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 
 /**
- * Fired when a channel topic is cleared.
+ * Marker interface used to identify an event that should be dispatched asynchronously by a
+ * {@link DynamicAsyncEventBus}.
  */
-public class ChanelNotopicEvent extends ChannelDisplayableEvent {
-
-    public ChanelNotopicEvent(final long timestamp, final Channel channel) {
-        super(timestamp, channel);
-    }
-
-    public ChanelNotopicEvent(final Channel channel) {
-        super(channel);
-    }
-
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface AsyncEvent {
 }

src/com/dmdirc/util/DynamicAsyncEventBus.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2006-2014 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.util;
+
+import com.google.common.eventbus.EventBus;
+
+import java.util.concurrent.Executor;
+
+/**
+ * An {@link EventBus} that will dispatch events asynchronously if they annotated with
+ * {@link AsyncEvent}.
+ */
+public class DynamicAsyncEventBus extends EventBus {
+
+    private final Executor executor;
+
+    public DynamicAsyncEventBus(final Executor executor) {
+        this.executor = executor;
+    }
+
+    @Override
+    public void post(final Object event) {
+        if (event.getClass().isAnnotationPresent(AsyncEvent.class)) {
+            executor.execute(new Runnable() {
+                @Override
+                public void run() {
+                    DynamicAsyncEventBus.super.post(event);
+                }
+            });
+        } else {
+            super.post(event);
+        }
+    }
+
+}