[freenet-cvs] r15805 - trunk/freenet/src/freenet/pluginmanager

[saces at freenetproject.org]

Author: saces
Date: 2007-11-17 22:37:47 +0000 (Sat, 17 Nov 2007)
New Revision: 15805

Modified:
   trunk/freenet/src/freenet/pluginmanager/FredPluginFCP.java
Log:
add comment

Modified: trunk/freenet/src/freenet/pluginmanager/FredPluginFCP.java
===================================================================
--- trunk/freenet/src/freenet/pluginmanager/FredPluginFCP.java	2007-11-17 22:23:47 UTC (rev 15804)
+++ trunk/freenet/src/freenet/pluginmanager/FredPluginFCP.java	2007-11-17 22:37:47 UTC (rev 15805)
@@ -6,6 +6,19 @@
 import freenet.node.fcp.FCPMessage;
 import freenet.support.SimpleFieldSet;
 
+/**
+ * Interface that has to be implemented for plugins that want to add fcp commands
+ * 
+ * the namesheme is plugin.class.commandname
+ * the node looks for the plugin "plugin.class" (the implementor of this interface)
+ * and ask him for the FCPCommand corresponding to "commandname".
+ * If the plugin don't know what to do with "commandname" it returns null.
+ * 
+ * see plugins.FCPHello for a simple sample.
+ * 
+ * @author saces
+ *
+ */
 public interface FredPluginFCP {
 	
 	FCPMessage create(String name, SimpleFieldSet fs);