Author: mes
Date: 2010-07-21 12:41:16 -0700 (Wed, 21 Jul 2010)
New Revision: 20982
Modified:
core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPlugin.java
core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPluginAdapter.java
Log:
added javadoc
Modified:
core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPlugin.java
===================================================================
--- core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPlugin.java
2010-07-21 19:26:43 UTC (rev 20981)
+++ core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPlugin.java
2010-07-21 19:41:16 UTC (rev 20982)
@@ -1,6 +1,10 @@
package org.cytoscape.plugin;
+/**
+ * The primary plugin interface for Cytoscape that all
+ * plugins must extend.
+ */
public abstract class CyPlugin {
protected CyPluginAdapter adapter;
@@ -10,6 +14,21 @@
throw new NullPointerException("no adapter provided!");
}
+ /**
+ * The constructor that all plugins must call using "super(adapter);"
where
+ * the "adapter" is a {...@link CyPluginAdapter} reference provided as
an
+ * argument to the constructor. Cytoscape's plugin loader will execute
+ * the constructor and provide the proper CyPluginAdapter reference.
+ * <br/>
+ * <code>
+ * public class MyPlugin extends CyPlugin {
+ * public MyPlugin(CyPluginAdapter adapter) {
+ * super(adapter);
+ * // plugin code here
+ * }
+ * }
+ * </code>
+ */
public CyPlugin(final CyPluginAdapter adapter) {
this.adapter = adapter;
}
Modified:
core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPluginAdapter.java
===================================================================
---
core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPluginAdapter.java
2010-07-21 19:26:43 UTC (rev 20981)
+++
core3/plugin-api/trunk/src/main/java/org/cytoscape/plugin/CyPluginAdapter.java
2010-07-21 19:41:16 UTC (rev 20982)
@@ -7,31 +7,31 @@
/**
- * A Java-only api providing access to cytoscape functionality.
+ * A Java-only api providing access to Cytoscape functionality.
*/
public interface CyPluginAdapter {
/**
- * Returns an instance of CyNetworkFactory.
- * @return an instance of CyNetworkFactory.
+ * Returns an instance of {...@link CyNetworkFactory}.
+ * @return an instance of {...@link CyNetworkFactory}.
*/
CyNetworkFactory getCyNetworkFactory();
/**
- * Returns an instance of CyNetworkFactory.
- * @return an instance of CyNetworkFactory.
+ * Returns an instance of {...@link CyDataTableFactory}.
+ * @return an instance of {...@link CyDataTableFactory}.
*/
CyDataTableFactory getCyDataTableFactory();
/**
- * Returns an instance of CyNetworkFactory.
- * @return an instance of CyNetworkFactory.
+ * Returns an instance of {...@link CyNetworkViewFactory}.
+ * @return an instance of {...@link CyNetworkViewFactory}.
*/
CyNetworkViewFactory getCyNetworkViewFactory();
/**
- * Returns an instance of CyNetworkFactory.
- * @return an instance of CyNetworkFactory.
+ * Returns an instance of {...@link TaskManager}.
+ * @return an instance of {...@link TaskManager}.
*/
TaskManager getTaskManager();
}
--
You received this message because you are subscribed to the Google Groups
"cytoscape-cvs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/cytoscape-cvs?hl=en.
