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.plugin;
21  
22  /***
23   * Plugins extend the functionality of the main program. Plugins are allowed
24   * to hook into XNap wherever they want. 
25   *
26   * Each plugin will only be instantiated once. First <code>start()</code> is
27   * called. If the gui is enabled then <code>startGUI()</code> will be called
28   * next. The plugin has to setup all gui parts by itself. When the plugin is
29   * disabled or XNap is shutdown <code>stopGUI()</code> is called (if
30   * <code>startGUI()</code> was called) and <code>stop()</code> afterwards.
31   */
32  public interface Plugin
33  {
34  
35      //--- Method(s) ---
36      
37      /***
38       * Returns information about this plugin.
39       */
40      PluginInfo getInfo();
41  
42      /***
43       * Sets the information record for this plugin. Called by 
44       * {@link xnap.plugin.PluginManager PluginManager}.
45       *
46       * @param info the info record
47       */
48      void setInfo(PluginInfo info);
49  
50      /***
51       * Called each time the plugin is enabled.
52       */
53      void start() throws Exception;
54  
55      /***
56       * Called each time the gui part of the plugin is enabled.
57       */
58      void startGUI();
59  
60      /***
61       * Called each time the plugin is disabled.
62       */
63      void stop();
64  
65      /***
66       * Called each time the gui part of the plugin is disabled.
67       */
68      void stopGUI();
69  
70  }