Use listeners for nicklist updates

Fixes CLIENT-81

Change-Id: I212bbe435df34981d3cde17a2d042f3662bec6c3
Reviewed-on: http://gerrit.dmdirc.com/1624
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/Channel.java

@@ -29,6 +29,7 @@ import com.dmdirc.commandparser.CommandType;
 import com.dmdirc.commandparser.parsers.ChannelCommandParser;
 import com.dmdirc.config.ConfigManager;
 import com.dmdirc.interfaces.ConfigChangeListener;
+import com.dmdirc.interfaces.NicklistListener;
 import com.dmdirc.interfaces.TopicChangeListener;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
 import com.dmdirc.parser.interfaces.ChannelInfo;
@@ -319,8 +320,8 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
 
         setIcon("channel-inactive");
 
-        for (ChannelWindow window : getWindows()) {
-            window.updateNames(new ArrayList<ChannelClientInfo>());
+        for (NicklistListener listener : listeners.get(NicklistListener.class)) {
+            listener.clientListUpdated(new ArrayList<ChannelClientInfo>());
         }
     }
 
@@ -365,14 +366,34 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
         }
     }
 
+    /**
+     * Registers a new nicklist listener for this channel.
+     *
+     * @since 0.6.5
+     * @param listener The listener to be added
+     */
+    public void addNicklistListener(final NicklistListener listener) {
+        listeners.add(NicklistListener.class, listener);
+    }
+
+    /**
+     * Removes the specified nicklist listener from this channel.
+     *
+     * @since 0.6.5
+     * @param listener The listener to be removed
+     */
+    public void removeNicklistListener(final NicklistListener listener) {
+        listeners.remove(NicklistListener.class, listener);
+    }
+
     /**
      * Adds a ChannelClient to this Channel.
      *
      * @param client The client to be added
      */
     public void addClient(final ChannelClientInfo client) {
-        for (ChannelWindow window : getWindows()) {
-            window.addName(client);
+        for (NicklistListener listener : listeners.get(NicklistListener.class)) {
+            listener.clientAdded(client);
         }
 
         tabCompleter.addEntry(TabCompletionType.CHANNEL_NICK, client.getClient().getNickname());
@@ -384,8 +405,8 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
      * @param client The client to be removed
      */
     public void removeClient(final ChannelClientInfo client) {
-        for (ChannelWindow window : getWindows()) {
-            window.removeName(client);
+        for (NicklistListener listener : listeners.get(NicklistListener.class)) {
+            listener.clientRemoved(client);
         }
 
         tabCompleter.removeEntry(TabCompletionType.CHANNEL_NICK, client.getClient().getNickname());
@@ -402,8 +423,8 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
      * @param clients The list of clients to use
      */
     public void setClients(final Collection<ChannelClientInfo> clients) {
-        for (ChannelWindow window : getWindows()) {
-            window.updateNames(clients);
+        for (NicklistListener listener : listeners.get(NicklistListener.class)) {
+            listener.clientListUpdated(clients);
         }
 
         tabCompleter.clear(TabCompletionType.CHANNEL_NICK);
@@ -434,8 +455,8 @@ public class Channel extends MessageTarget<ChannelWindow> implements ConfigChang
             return;
         }
 
-        for (ChannelWindow window : getWindows()) {
-            window.updateNames();
+        for (NicklistListener listener : listeners.get(NicklistListener.class)) {
+            listener.clientListUpdated();
         }
     }
 

src/com/dmdirc/commandparser/commands/channel/SetNickColour.java

@@ -93,9 +93,7 @@ public final class SetNickColour extends Command implements IntelligentCommand,
                 target.getMap().remove(ChannelClientProperty.TEXT_FOREGROUND);
             }
 
-            for (ChannelWindow window : channel.getWindows()) {
-                window.redrawNicklist();
-            }
+            channel.refreshClients();
         } else {
             // We're setting the colour
             final Color newColour = ColourManager.parseColour(args.getArguments()[offset], null);
@@ -112,9 +110,7 @@ public final class SetNickColour extends Command implements IntelligentCommand,
                 target.getMap().put(ChannelClientProperty.TEXT_FOREGROUND, newColour);
             }
 
-            for (ChannelWindow window : channel.getWindows()) {
-                window.redrawNicklist();
-            }
+            channel.refreshClients();
         }
     }
 

src/com/dmdirc/interfaces/NicklistListener.java

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.interfaces;
+
+import com.dmdirc.parser.interfaces.ChannelClientInfo;
+import java.util.Collection;
+
+/**
+ * Interface for objects interested in receiving updates pertaining to a
+ * channel's list of active users (the 'nicklist').
+ *
+ * @since 0.6.5
+ * @author chris
+ */
+public interface NicklistListener {
+
+    /**
+     * Called to indicate the client list has been extensively updated,
+     * and any cached data should be discarded and replaced with the specified
+     * set of clients.
+     * 
+     * @param clients The new set of clients for the channel
+     */
+    void clientListUpdated(Collection<ChannelClientInfo> clients);
+    
+    /**
+     * Called to indicate a member of the channel has had their nicklist entry
+     * changed in some manner, and their display text, colours, etc, should be
+     * re-read from the object.
+     */
+    void clientListUpdated();
+    
+    /**
+     * Called to indicate a new client has been added to the nicklist
+     * 
+     * @param client The new client that has been added
+     */
+    void clientAdded(ChannelClientInfo client);
+    
+    /**
+     * Called to indicate a client has been removed from the nicklist
+     * 
+     * @param client The client that has been removed
+     */
+    void clientRemoved(ChannelClientInfo client);
+
+}

src/com/dmdirc/ui/interfaces/ChannelWindow.java

@@ -23,8 +23,9 @@
 package com.dmdirc.ui.interfaces;
 
 import com.dmdirc.Channel;
-
+import com.dmdirc.interfaces.NicklistListener;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
+
 import java.util.Collection;
 
 /**
@@ -38,27 +39,35 @@ public interface ChannelWindow extends InputWindow {
      * Updates the channel's name list to the specified list of clients.
      * 
      * @param clients The new list of clients for this channel
+     * @deprecated Use a {@link NicklistListener}
      */
+    @Deprecated
     void updateNames(Collection<ChannelClientInfo> clients);
     
     /**
      * Adds the specified client to this channel's name list.
      * 
      * @param client The new client to be added
+     * @deprecated Use a {@link NicklistListener}
      */
+    @Deprecated
     void addName(ChannelClientInfo client);
     
     /**
      * Removes the specified client from this channel's name list.
      * 
      * @param client The client to be removed
+     * @deprecated Use a {@link NicklistListener}
      */
+    @Deprecated
     void removeName(ChannelClientInfo client);
     
     /**
      * Requests that the channel window updates the displayed list of channel
      * clients, to take into account mode or nickname changes.
+     * @deprecated Use a {@link NicklistListener}
      */
+    @Deprecated
     void updateNames();
     
     /**
@@ -72,7 +81,10 @@ public interface ChannelWindow extends InputWindow {
     
     /**
      * Redraws the nicklist belonging to this channel.
+     *
+     * @deprecated Use a {@link NicklistListener}
      */
+    @Deprecated
     void redrawNicklist();
 
 }