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 import javax.swing.Action;
23
24 /***
25 * Defines the requirements for classes that provide access to chat channels.
26 */
27 public interface ChatProvider {
28
29 //--- Data field(s) ---
30
31 //--- Method(s) ---
32
33 /***
34 * Adds <code>listener</code> to the provider.
35 */
36 void addChatProviderListener(ChatProviderListener listener);
37
38 /***
39 * Joins a channel.
40 */
41 void join(String channel);
42
43 /***
44 * Returns an array of actions that can be performed on the provider.
45 */
46 Action[] getActions();
47
48 /***
49 * Returns the the channels on this server.
50 */
51 ChannelInfo[] getChannels();
52
53 /***
54 * Returns an information record.
55 */
56 //ChannelInfo getInfo(String channel);
57
58 /***
59 * Returns a string with the message of the day.
60 */
61 String getMessages();
62
63 /***
64 * Returns the name of the server shown to the user.
65 */
66 String getName();
67
68 /***
69 * Removes <code>listener</code> from the provider.
70 */
71 void removeChatProviderListener(ChatProviderListener listener);
72
73 }
74
75
76
77