001/**
002 *
003 * Copyright 2003-2007 Jive Software.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package org.jivesoftware.smackx.xroster;
019
020import java.util.Iterator;
021
022import org.jxmpp.jid.Jid;
023
024/**
025 *
026 * A listener that is fired anytime a roster exchange is received.
027 *
028 * @author Gaston Dombiak
029 */
030public interface RosterExchangeListener {
031
032    /**
033     * Called when roster entries are received as part of a roster exchange.
034     *
035     * @param from the user that sent the entries.
036     * @param remoteRosterEntries the entries sent by the user. The entries are instances of
037     * RemoteRosterEntry.
038     */
039    void entriesReceived(Jid from, Iterator<RemoteRosterEntry> remoteRosterEntries);
040
041}