Make Gateway into a type of Plugin

ctrueden · ctrueden · commit 7b679704b521 · 2014-02-19T13:03:23.000-06:00
This allows available Gateways to be discovered at runtime, which can be useful for some purposes. For example, the Script Editor will use this mechanism in the future to register shortcut aliases for the Gateways, so that you can write: // @imagej ij Instead of needing to write out the FQCN: // @imagej.ImageJ ij
diff --git a/src/main/java/org/scijava/AbstractGateway.java b/src/main/java/org/scijava/AbstractGateway.java
@@ -39,6 +39,7 @@
 import org.scijava.event.EventService;
 import org.scijava.log.LogService;
 import org.scijava.object.ObjectService;
+import org.scijava.plugin.AbstractRichPlugin;
 import org.scijava.plugin.PluginService;
 import org.scijava.service.Service;
 import org.scijava.thread.ThreadService;
@@ -49,7 +50,7 @@
  * @author Mark Hiner
  * @author Curtis Rueden
  */
-public abstract class AbstractGateway extends AbstractContextual implements
+public abstract class AbstractGateway extends AbstractRichPlugin implements
 	Gateway
 {
 
diff --git a/src/main/java/org/scijava/Gateway.java b/src/main/java/org/scijava/Gateway.java
@@ -38,7 +38,9 @@
 import org.scijava.event.EventService;
 import org.scijava.log.LogService;
 import org.scijava.object.ObjectService;
+import org.scijava.plugin.Plugin;
 import org.scijava.plugin.PluginService;
+import org.scijava.plugin.RichPlugin;
 import org.scijava.service.Service;
 import org.scijava.thread.ThreadService;
 
@@ -86,12 +88,19 @@
  * a {@link NoSuchServiceException} is thrown, which facilitates appropriate
  * (but optional) handling of missing services.
  * </p>
+ * <p>
+ * Gateways discoverable at runtime must implement this interface and be
+ * annotated with @{@link Gateway} with attribute {@link Plugin#type()} =
+ * {@link Gateway}.class. While it possible to create a gateway merely by
+ * implementing this interface, it is encouraged to instead extend
+ * {@link AbstractGateway}, for convenience.
+ * </p>
  * 
  * @see Context
  * @author Mark Hiner
  * @author Curtis Rueden
  */
-public interface Gateway extends Contextual {
+public interface Gateway extends RichPlugin {
 
 	/**
 	 * Returns an implementation of the requested {@link Service}, if it exists in
