NodeInformationProvider


1   /**
2    * $RCSfile$
3    * $Revision: 2407 $
4    * $Date: 2004-11-02 20:37:00 -0300 (Tue, 02 Nov 2004) $
5    *
6    * Copyright 2003-2004 Jive Software.
7    *
8    * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
9    * you may not use this file except in compliance with the License.
10   * You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  
21  package org.jivesoftware.smackx;
22  
23  import java.util.Iterator  ;
24  
25  
26  /**
27   * The NodeInformationProvider is responsible for providing information (i.e. DiscoverItems.Item)
28   * about a given node. This information will be requested each time this XMPPP client receives a
29   * disco items requests on the given node.
30   * 
31   * @author Gaston Dombiak
32   */
33  public interface NodeInformationProvider {
34      
35      /**
36       * Returns an Iterator on the Items {@link org.jivesoftware.smackx.packet.DiscoverItems.Item} 
37       * defined in the node. For example, the MUC protocol specifies that an XMPP client should 
38       * answer an Item for each joined room when asked for the rooms where the use has joined.
39       *  
40       * @return an Iterator on the Items defined in the node.
41       */
42      public abstract Iterator   getNodeItems();
43  
44  }
45

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags