Added support for roster listeners.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@1887 b35dd754-fafc-0310-a699-88a17e54d16e

source/org/jivesoftware/smack/Roster.java

@@ -68,17 +68,24 @@ public class Roster {
 
     private XMPPConnection connection;
     private Map groups;
+    private List rosterListeners;
     // The roster is marked as initialized when at least a single roster packet
     // has been recieved and processed.
     boolean rosterInitialized = false;
 
+    /**
+     * Creates a new roster.
+     *
+     * @param connection an XMPP connection.
+     */
     Roster(final XMPPConnection connection) {
         this.connection = connection;
         groups = new HashMap();
+        rosterListeners = new ArrayList();
         // Listen for any roster packets.
         PacketFilter filter = new PacketTypeFilter(RosterPacket.class);
-        PacketListener rosterListener = new RosterListener();
+        PacketListener rosterPacketListener = new RosterPacketListener();
-        connection.addPacketListener(rosterListener, filter);
+        connection.addPacketListener(rosterPacketListener, filter);
     }
 
     /**
@@ -90,6 +97,32 @@ public class Roster {
         connection.sendPacket(new RosterPacket());
     }
 
+    /**
+     * Adds a listener to this roster. The listener will be fired anytime one or more
+     * changes to the roster are pushed from the server.
+     *
+     * @param rosterListener a roster listener.
+     */
+    public void addRosterListner(RosterListener rosterListener) {
+        synchronized (rosterListeners) {
+            if (!rosterListeners.contains(rosterListener)) {
+                rosterListeners.add(rosterListener);
+            }
+        }
+    }
+
+    /**
+     * Removes a listener from this roster. The listener will be fired anytime one or more
+     * changes to the roster are pushed from the server.
+     *
+     * @param rosterListener a roster listener.
+     */
+    public void removeRosterListener(RosterListener rosterListener) {
+        synchronized (rosterListeners) {
+            rosterListeners.remove(rosterListener);
+        }
+    }
+
     /**
      * Creates a new group.
      *
@@ -157,10 +190,24 @@ public class Roster {
         }
     }
 
+    /**
+     * Fires roster listeners.
+     */
+    private void fireRosterListeners() {
+        RosterListener [] listeners = null;
+        synchronized (rosterListeners) {
+            listeners = new RosterListener[rosterListeners.size()];
+            rosterListeners.toArray(listeners);
+        }
+        for (int i=0; i<listeners.length; i++) {
+            listeners[i].rosterModified();
+        }
+    }
+
     /**
      * Listens for all roster packets and processes them.
      */
-    private class RosterListener implements PacketListener {
+    private class RosterPacketListener implements PacketListener {
 
         public void processPacket(Packet packet) {
             RosterPacket rosterPacket = (RosterPacket)packet;
@@ -209,8 +256,11 @@ public class Roster {
                 }
             }
 
+            // Fire event for roster listeners.
+            fireRosterListeners();
+
             // Mark the roster as initialized.
             rosterInitialized = true;
         }
     }
-}
+}

source/org/jivesoftware/smack/RosterListener.java

@@ -0,0 +1,67 @@
+/**
+ * $RCSfile$
+ * $Revision$
+ * $Date$
+ *
+ * Copyright (C) 2002-2003 Jive Software. All rights reserved.
+ * ====================================================================
+ * The Jive Software License (based on Apache Software License, Version 1.1)
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ *
+ * 3. The end-user documentation included with the redistribution,
+ *    if any, must include the following acknowledgment:
+ *       "This product includes software developed by
+ *        Jive Software (http://www.jivesoftware.com)."
+ *    Alternately, this acknowledgment may appear in the software itself,
+ *    if and wherever such third-party acknowledgments normally appear.
+ *
+ * 4. The names "Smack" and "Jive Software" must not be used to
+ *    endorse or promote products derived from this software without
+ *    prior written permission. For written permission, please
+ *    contact webmaster@jivesoftware.com.
+ *
+ * 5. Products derived from this software may not be called "Smack",
+ *    nor may "Smack" appear in their name, without prior written
+ *    permission of Jive Software.
+ *
+ * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED.  IN NO EVENT SHALL JIVE SOFTWARE OR
+ * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+ * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ * ====================================================================
+ */
+
+package org.jivesoftware.smack;
+
+/**
+ *
+ * @author Matt Tucker
+ */
+public interface RosterListener {
+
+    /**
+     * Called when the roster is modified.
+     */
+   public void rosterModified();
+
+}
+