Add events for statusbar stuff.

Change-Id: I12e1a5e7b190c0a54da7a9b205c9446ecc5728e5
Reviewed-on: http://gerrit.dmdirc.com/3767
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/events/StatusBarComponentAddedEvent.java

@@ -0,0 +1,35 @@
+/*
+ * 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.events;
+
+import com.dmdirc.interfaces.ui.StatusBarComponent;
+
+/**
+ * Fired when a component is to be added to a status bar.
+ */
+public class StatusBarComponentAddedEvent extends StatusBarComponentEvent {
+
+    public StatusBarComponentAddedEvent(final StatusBarComponent component) {
+        super(component);
+    }
+}

src/com/dmdirc/events/StatusBarComponentEvent.java

@@ -0,0 +1,41 @@
+/*
+ * 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.events;
+
+import com.dmdirc.interfaces.ui.StatusBarComponent;
+
+/**
+ * Base class for status bar component messages
+ */
+public abstract class StatusBarComponentEvent extends StatusBarEvent {
+
+    private final StatusBarComponent component;
+
+    public StatusBarComponentEvent(final StatusBarComponent component) {
+        this.component = component;
+    }
+
+    public StatusBarComponent getComponent() {
+        return component;
+    }
+}

src/com/dmdirc/events/StatusBarComponentRemovedEvent.java

@@ -0,0 +1,35 @@
+/*
+ * 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.events;
+
+import com.dmdirc.interfaces.ui.StatusBarComponent;
+
+/**
+ * Fired when a component is to be removed from a status bar.
+ */
+public class StatusBarComponentRemovedEvent extends StatusBarComponentEvent {
+
+    public StatusBarComponentRemovedEvent(final StatusBarComponent component) {
+        super(component);
+    }
+}

src/com/dmdirc/events/StatusBarEvent.java

@@ -0,0 +1,29 @@
+/*
+ * 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.events;
+
+/**
+ * Base class for all status bar events.
+ */
+public abstract class StatusBarEvent {
+}

src/com/dmdirc/events/StatusBarMessageClearEvent.java

@@ -0,0 +1,29 @@
+/*
+ * 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.events;
+
+/**
+ * Fired to clear the status bar message.
+ */
+public class StatusBarMessageClearEvent extends StatusBarEvent {
+}

src/com/dmdirc/events/StatusBarMessageEvent.java

@@ -0,0 +1,41 @@
+/*
+ * 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.events;
+
+import com.dmdirc.ui.StatusMessage;
+
+/**
+ * Fired when a status bar message is to be presented to a user.
+ */
+public class StatusBarMessageEvent extends StatusBarEvent {
+
+    private final StatusMessage message;
+
+    public StatusBarMessageEvent(final StatusMessage message) {
+        this.message = message;
+    }
+
+    public StatusMessage getMessage() {
+        return message;
+    }
+}

src/com/dmdirc/ui/core/components/StatusBarManager.java

@@ -22,6 +22,10 @@
 
 package com.dmdirc.ui.core.components;
 
+import com.dmdirc.events.StatusBarComponentAddedEvent;
+import com.dmdirc.events.StatusBarComponentRemovedEvent;
+import com.dmdirc.events.StatusBarMessageClearEvent;
+import com.dmdirc.events.StatusBarMessageEvent;
 import com.dmdirc.interfaces.ui.StatusBar;
 import com.dmdirc.interfaces.ui.StatusBarComponent;
 import com.dmdirc.ui.StatusMessage;
@@ -32,6 +36,8 @@ import java.util.concurrent.CopyOnWriteArraySet;
 import javax.inject.Inject;
 import javax.inject.Singleton;
 
+import net.engio.mbassy.bus.MBassador;
+
 /**
  * A manager for status bars or status bar like components.
  *
@@ -42,12 +48,12 @@ public class StatusBarManager implements StatusBar {
 
     /** A collection of known status bars. */
     private final Collection<StatusBar> statusBars = new CopyOnWriteArraySet<>();
+    /** Event bus to fire status bar events on. */
+    private final MBassador eventBus;
 
-    /**
-     * Creates a new instance of {@link StatusBarManager}.
-     */
     @Inject
-    public StatusBarManager() {
+    public StatusBarManager(final MBassador eventBus) {
+        this.eventBus = eventBus;
     }
 
     /**
@@ -69,33 +75,33 @@ public class StatusBarManager implements StatusBar {
         statusBars.remove(statusBar);
     }
 
-    /** {@inheritDoc} */
     @Override
     public void setMessage(final StatusMessage message) {
+        eventBus.publishAsync(new StatusBarMessageEvent(message));
         for (StatusBar statusBar : statusBars) {
             statusBar.setMessage(message);
         }
     }
 
-    /** {@inheritDoc} */
     @Override
     public void clearMessage() {
+        eventBus.publishAsync(new StatusBarMessageClearEvent());
         for (StatusBar statusBar : statusBars) {
             statusBar.clearMessage();
         }
     }
 
-    /** {@inheritDoc} */
     @Override
     public void addComponent(final StatusBarComponent component) {
+        eventBus.publishAsync(new StatusBarComponentAddedEvent(component));
         for (StatusBar statusBar : statusBars) {
             statusBar.addComponent(component);
         }
     }
 
-    /** {@inheritDoc} */
     @Override
     public void removeComponent(final StatusBarComponent component) {
+        eventBus.publishAsync(new StatusBarComponentRemovedEvent(component));
         for (StatusBar statusBar : statusBars) {
             statusBar.removeComponent(component);
         }

test/com/dmdirc/ui/core/components/StatusBarManagerTest.java

@@ -26,15 +26,26 @@ import com.dmdirc.interfaces.ui.StatusBarComponent;
 import com.dmdirc.ui.StatusMessage;
 
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
 
-import static org.mockito.Mockito.*;
+import net.engio.mbassy.bus.MBassador;
 
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyZeroInteractions;
+
+@RunWith(MockitoJUnitRunner.class)
 public class StatusBarManagerTest {
 
+    @Mock
+    private MBassador eventBus;
+
     @Test
     public void testRegisterStatusBar() {
         final StatusBar sb = mock(StatusBar.class);
-        StatusBarManager instance = new StatusBarManager();
+        StatusBarManager instance = new StatusBarManager(eventBus);
         instance.registerStatusBar(sb);
         instance.clearMessage();
         verify(sb).clearMessage();
@@ -43,7 +54,7 @@ public class StatusBarManagerTest {
     @Test
     public void testUnregisterStatusBar() {
         final StatusBar sb = mock(StatusBar.class);
-        StatusBarManager instance = new StatusBarManager();
+        StatusBarManager instance = new StatusBarManager(eventBus);
         instance.registerStatusBar(sb);
         instance.unregisterStatusBar(sb);
         instance.clearMessage();
@@ -54,7 +65,7 @@ public class StatusBarManagerTest {
     public void testSetMessage() {
         final StatusMessage message = mock(StatusMessage.class);
         final StatusBar sb = mock(StatusBar.class);
-        StatusBarManager instance = new StatusBarManager();
+        StatusBarManager instance = new StatusBarManager(eventBus);
         instance.registerStatusBar(sb);
         instance.setMessage(message);
         verify(sb).setMessage(message);
@@ -63,7 +74,7 @@ public class StatusBarManagerTest {
     @Test
     public void testClearMessage() {
         final StatusBar sb = mock(StatusBar.class);
-        StatusBarManager instance = new StatusBarManager();
+        StatusBarManager instance = new StatusBarManager(eventBus);
         instance.registerStatusBar(sb);
         instance.clearMessage();
         verify(sb).clearMessage();
@@ -73,7 +84,7 @@ public class StatusBarManagerTest {
     public void testAddComponent() {
         final StatusBarComponent comp = mock(StatusBarComponent.class);
         final StatusBar sb = mock(StatusBar.class);
-        StatusBarManager instance = new StatusBarManager();
+        StatusBarManager instance = new StatusBarManager(eventBus);
         instance.registerStatusBar(sb);
         instance.addComponent(comp);
         verify(sb).addComponent(comp);
@@ -83,7 +94,7 @@ public class StatusBarManagerTest {
     public void testRemoveComponent() {
         final StatusBarComponent comp = mock(StatusBarComponent.class);
         final StatusBar sb = mock(StatusBar.class);
-        StatusBarManager instance = new StatusBarManager();
+        StatusBarManager instance = new StatusBarManager(eventBus);
         instance.registerStatusBar(sb);
         instance.removeComponent(comp);
         verify(sb).removeComponent(comp);