View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package org.xnap.chat;
21  
22  
23  /***
24   * Defines the requirements for classes that provide channel information. 
25   *
26   * @see Channel
27   * @see ChatProvider
28   */
29  public interface ChannelInfo {
30  
31      //--- Constant(s) ---
32  
33      //--- Method(s) ---
34  
35      /***
36       * Returns the name of the channel.
37       */
38      String getName();
39  
40      /***
41       * Returns the number of peers that have joined this channel.
42       */
43      int getPeerCount();
44  
45      /***
46       * Returns the topic of this channel.
47       */
48      String getTopic();
49  
50  }