Author: mes
Date: 2011-11-28 12:46:50 -0800 (Mon, 28 Nov 2011)
New Revision: 27609
Added:
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/AbstractCyPlugin.java
Removed:
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/CyPlugin.java
Modified:
core3/api/trunk/plugin-api/src/test/java/org/cytoscape/plugin/CyPluginTest.java
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/CyPluginAdapterImpl.java
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/PluginManager.java
core3/support/trunk/samples/sample02a/src/main/java/org/cytoscape/sample/internal/Sample02aPlugin.java
core3/support/trunk/samples/sample03a/src/main/java/org/cytoscape/sample/internal/Sample03aPlugin.java
core3/support/trunk/samples/sample05a/src/main/java/org/cytoscape/sample/internal/Sample05aPlugin.java
Log:
Changed CyPlugin to AbstractCyPlugin to reflect naming convention.
Copied:
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/AbstractCyPlugin.java
(from rev 27606,
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/CyPlugin.java)
===================================================================
---
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/AbstractCyPlugin.java
(rev 0)
+++
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/AbstractCyPlugin.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -0,0 +1,52 @@
+package org.cytoscape.plugin;
+
+
+/**
+ * The primary plugin interface for Cytoscape that all
+ * plugins must extend. Plugin developers will have access
+ * to all Cytoscape 3.X services, but are not required to
+ * know about or use Maven, OSGi, or Spring.
+ * However, there are limitations on which packages may
+ * be included in the plugin jar based on those already loaded in the
classpath.
+ * To load alternative versions of the same library used by other plugins or
+ * Cytoscape itself, it will be necessary to write your plugin using OSGi
+ * and Spring.
+ * @CyAPI.Abstract.Class
+ */
+public abstract class AbstractCyPlugin {
+
+ /**
+ * Reference to access Cytoscape functionality -- various managers and
+ * factories that are normally available as OSGi services.
+ */
+ protected CyPluginAdapter adapter;
+
+ // so no one calls this constructor
+ private AbstractCyPlugin() {
+ 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/>
+ *
+ * <blockquote><pre>
+ * public class MyPlugin extends CyPlugin {
+ * public MyPlugin(CyPluginAdapter adapter) {
+ * super(adapter);
+ * // plugin code here
+ * }
+ * }
+ * </pre></blockquote>
+ * @param adapter a {@link CyPluginAdapter} reference provided as an
+ * argument to the constructor.
+ */
+ public AbstractCyPlugin(final CyPluginAdapter adapter) {
+ if ( adapter == null )
+ throw new NullPointerException("null adapter");
+ this.adapter = adapter;
+ }
+}
Deleted:
core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/CyPlugin.java
===================================================================
--- core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/CyPlugin.java
2011-11-28 20:34:33 UTC (rev 27608)
+++ core3/api/trunk/plugin-api/src/main/java/org/cytoscape/plugin/CyPlugin.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -1,52 +0,0 @@
-package org.cytoscape.plugin;
-
-
-/**
- * The primary plugin interface for Cytoscape that all
- * plugins must extend. Plugin developers will have access
- * to all Cytoscape 3.X services, but are not required to
- * know about or use Maven, OSGi, or Spring.
- * However, there are limitations on which packages may
- * be included in the plugin jar based on those already loaded in the
classpath.
- * To load alternative versions of the same library used by other plugins or
- * Cytoscape itself, it will be necessary to write your plugin using OSGi
- * and Spring.
- * @CyAPI.Abstract.Class
- */
-public abstract class CyPlugin {
-
- /**
- * Reference to access Cytoscape functionality -- various managers and
- * factories that are normally available as OSGi services.
- */
- protected CyPluginAdapter adapter;
-
- // so no one calls this constructor
- private CyPlugin() {
- 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/>
- *
- * <blockquote><pre>
- * public class MyPlugin extends CyPlugin {
- * public MyPlugin(CyPluginAdapter adapter) {
- * super(adapter);
- * // plugin code here
- * }
- * }
- * </pre></blockquote>
- * @param adapter a {@link CyPluginAdapter} reference provided as an
- * argument to the constructor.
- */
- public CyPlugin(final CyPluginAdapter adapter) {
- if ( adapter == null )
- throw new NullPointerException("null adapter");
- this.adapter = adapter;
- }
-}
Modified:
core3/api/trunk/plugin-api/src/test/java/org/cytoscape/plugin/CyPluginTest.java
===================================================================
---
core3/api/trunk/plugin-api/src/test/java/org/cytoscape/plugin/CyPluginTest.java
2011-11-28 20:34:33 UTC (rev 27608)
+++
core3/api/trunk/plugin-api/src/test/java/org/cytoscape/plugin/CyPluginTest.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -8,7 +8,7 @@
public class CyPluginTest {
- private static class MyPlugin extends CyPlugin {
+ private static class MyPlugin extends AbstractCyPlugin {
MyPlugin(CyPluginAdapter a) {
super(a);
}
Modified:
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/CyPluginAdapterImpl.java
===================================================================
---
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/CyPluginAdapterImpl.java
2011-11-28 20:34:33 UTC (rev 27608)
+++
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/CyPluginAdapterImpl.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -31,7 +31,7 @@
import org.cytoscape.model.CyTableManager;
import org.cytoscape.model.events.AboutToRemoveEdgesEvent;
import org.cytoscape.model.subnetwork.CyRootNetworkFactory;
-import org.cytoscape.plugin.CyPlugin;
+import org.cytoscape.plugin.AbstractCyPlugin;
import org.cytoscape.plugin.CyPluginAdapter;
import org.cytoscape.property.SimpleCyProperty;
import org.cytoscape.property.CyProperty;
@@ -149,7 +149,7 @@
private AbstractWebServiceClient abstractWebServiceClient;
private DataImportFinishedEvent dataImportFinishedEvent;
private DropNetworkViewTaskFactory dropNetworkViewTaskFactory;
- private CyPlugin cyPlugin;
+ private AbstractCyPlugin cyPlugin;
private final VisualMappingFunctionFactory
visualMappingFunctionContinuousFactory;
private final VisualMappingFunctionFactory
visualMappingFunctionDiscreteFactory;
private final VisualMappingFunctionFactory
visualMappingFunctionPassthroughFactory;
Modified:
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/PluginManager.java
===================================================================
---
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/PluginManager.java
2011-11-28 20:34:33 UTC (rev 27608)
+++
core3/impl/trunk/plugin-impl/src/main/java/org/cytoscape/plugin/internal/PluginManager.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -37,7 +37,7 @@
package org.cytoscape.plugin.internal;
import org.cytoscape.application.CyApplicationConfiguration;
-import org.cytoscape.plugin.CyPlugin;
+import org.cytoscape.plugin.AbstractCyPlugin;
import org.cytoscape.plugin.CyPluginAdapter;
import org.cytoscape.plugin.internal.action.PluginManagerAction;
import org.cytoscape.plugin.internal.util.FileUtil;
Modified:
core3/support/trunk/samples/sample02a/src/main/java/org/cytoscape/sample/internal/Sample02aPlugin.java
===================================================================
---
core3/support/trunk/samples/sample02a/src/main/java/org/cytoscape/sample/internal/Sample02aPlugin.java
2011-11-28 20:34:33 UTC (rev 27608)
+++
core3/support/trunk/samples/sample02a/src/main/java/org/cytoscape/sample/internal/Sample02aPlugin.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -1,12 +1,12 @@
package org.cytoscape.sample.internal;
import org.cytoscape.plugin.CyPluginAdapter;
-import org.cytoscape.plugin.CyPlugin;
+import org.cytoscape.plugin.AbstractCyPlugin;
/**
* An implementation of CyPluginAdapter
*/
-public class Sample02aPlugin extends CyPlugin {
+public class Sample02aPlugin extends AbstractCyPlugin {
public Sample02aPlugin(CyPluginAdapter a){
super(a);
Modified:
core3/support/trunk/samples/sample03a/src/main/java/org/cytoscape/sample/internal/Sample03aPlugin.java
===================================================================
---
core3/support/trunk/samples/sample03a/src/main/java/org/cytoscape/sample/internal/Sample03aPlugin.java
2011-11-28 20:34:33 UTC (rev 27608)
+++
core3/support/trunk/samples/sample03a/src/main/java/org/cytoscape/sample/internal/Sample03aPlugin.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -1,13 +1,13 @@
package org.cytoscape.sample.internal;
-import org.cytoscape.plugin.CyPlugin;
+import org.cytoscape.plugin.AbstractCyPlugin;
import org.cytoscape.plugin.CyPluginAdapter;
/**
* An implementation of CyPluginAdapter
*/
-public class Sample03aPlugin extends CyPlugin {
+public class Sample03aPlugin extends AbstractCyPlugin {
public Sample03aPlugin(CyPluginAdapter a){
super(a);
Modified:
core3/support/trunk/samples/sample05a/src/main/java/org/cytoscape/sample/internal/Sample05aPlugin.java
===================================================================
---
core3/support/trunk/samples/sample05a/src/main/java/org/cytoscape/sample/internal/Sample05aPlugin.java
2011-11-28 20:34:33 UTC (rev 27608)
+++
core3/support/trunk/samples/sample05a/src/main/java/org/cytoscape/sample/internal/Sample05aPlugin.java
2011-11-28 20:46:50 UTC (rev 27609)
@@ -2,14 +2,14 @@
import java.util.Dictionary;
import java.util.Hashtable;
-import org.cytoscape.plugin.CyPlugin;
+import org.cytoscape.plugin.AbstractCyPlugin;
import org.cytoscape.plugin.CyPluginAdapter;
import org.cytoscape.work.TaskFactory;
/**
* An implementation of CyPluginAdapter
*/
-public class Sample05aPlugin extends CyPlugin {
+public class Sample05aPlugin extends AbstractCyPlugin {
public Sample05aPlugin(CyPluginAdapter a){
super(a);
--
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.
