Merge branch 'versioned-plugins'

This makes RichPlugin extend more useful interfaces. In particular,
RichPlugins are now Versioned, a big step toward reproducibility.

I actually made this change two years ago, but it got lost in the
shuffle till now, because it was originally done in the context of
the usage statistics work, which was rejected by the community.

Author: ctrueden

src/main/java/org/scijava/AbstractGateway.java

@@ -274,13 +274,15 @@ public String getTitle() {
 	}
 
 	@Override
-	public String getVersion() {
-		return getApp().getVersion();
+	public String getInfo(final boolean mem) {
+		return getApp().getInfo(mem);
 	}
 
+	// -- Versioned methods --
+
 	@Override
-	public String getInfo(final boolean mem) {
-		return getApp().getInfo(mem);
+	public String getVersion() {
+		return getApp().getVersion();
 	}
 
 }

src/main/java/org/scijava/Gateway.java

@@ -118,7 +118,7 @@
  * @author Mark Hiner
  * @author Curtis Rueden
  */
-public interface Gateway extends RichPlugin, Versioned {
+public interface Gateway extends RichPlugin {
 
 	/**
 	 * Perform launch operations associated with this gateway.
@@ -362,10 +362,4 @@ public interface Gateway extends RichPlugin, Versioned {
 	/** @see org.scijava.app.App#getInfo(boolean) */
 	String getInfo(boolean mem);
 
-	// -- Versioned methods --
-
-	/** @see org.scijava.app.App#getVersion() */
-	@Override
-	String getVersion();
-
 }

src/main/java/org/scijava/Locatable.java

@@ -31,6 +31,10 @@
 
 package org.scijava;
 
+import java.net.URL;
+
+import org.scijava.util.ClassUtils;
+
 /**
  * An object whose location is defined by a URL string.
  * 
@@ -39,6 +43,9 @@
 public interface Locatable {
 
 	/** Gets the URL string defining the object's location. */
-	String getLocation();
+	default String getLocation() {
+		final URL location = ClassUtils.getLocation(getClass());
+		return location == null ? null : location.toExternalForm();
+	}
 
 }

src/main/java/org/scijava/Prioritized.java

@@ -31,6 +31,8 @@
 
 package org.scijava;
 
+import org.scijava.util.ClassUtils;
+
 /**
  * An object that can be sorted according to priority.
  * 
@@ -52,4 +54,18 @@ public interface Prioritized extends Comparable<Prioritized> {
 	 */
 	void setPriority(double priority);
 
+	// -- Comparable methods --
+
+	@Override
+	default int compareTo(final Prioritized that) {
+		if (that == null) return 1;
+
+		// compare priorities
+		final int priorityCompare = Priority.compare(this, that);
+		if (priorityCompare != 0) return priorityCompare;
+
+		// compare classes
+		return ClassUtils.compare(getClass(), that.getClass());
+	}
+
 }

src/main/java/org/scijava/Versioned.java

@@ -31,6 +31,8 @@
 
 package org.scijava;
 
+import org.scijava.util.VersionUtils;
+
 /**
  * An object that knows its version.
  * 
@@ -39,6 +41,9 @@
 public interface Versioned {
 
 	/** Gets the version of the object. */
-	String getVersion();
+	default String getVersion() {
+		return VersionUtils.getVersion(getClass());
+	}
+
 
 }

src/main/java/org/scijava/app/AbstractApp.java

@@ -56,33 +56,13 @@ public abstract class AbstractApp extends AbstractRichPlugin implements App {
 	/** JAR manifest with metadata about the application. */
 	private Manifest manifest;
 
+	// -- App methods --
+
 	@Override
 	public String getTitle() {
 		return getInfo().getName();
 	}
 
-	@Override
-	public String getVersion() {
-		// NB: We do not use VersionUtils.getVersion(c, groupId, artifactId)
-		// because that method does not cache the parsed Manifest and/or POM.
-		// We might have them already parsed here, and if not, we want to
-		// parse then cache locally, rather than discarding them afterwards.
-
-		// try the manifest first, since it might know its build number
-		final Manifest m = getManifest();
-		if (m != null) {
-			final String v = m.getVersion();
-			if (v != null) return v;
-		}
-		// try the POM
-		final POM p = getPOM();
-		if (p != null) {
-			final String v = p.getVersion();
-			if (v != null) return v;
-		}
-		return "Unknown";
-	}
-
 	@Override
 	public POM getPOM() {
 		if (pom == null) {
@@ -145,4 +125,28 @@ public void quit() {
 		getContext().dispose();
 	}
 
+	// -- Versioned methods --
+
+	@Override
+	public String getVersion() {
+		// NB: We do not use VersionUtils.getVersion(c, groupId, artifactId)
+		// because that method does not cache the parsed Manifest and/or POM.
+		// We might have them already parsed here, and if not, we want to
+		// parse then cache locally, rather than discarding them afterwards.
+
+		// try the manifest first, since it might know its build number
+		final Manifest m = getManifest();
+		if (m != null) {
+			final String v = m.getVersion();
+			if (v != null) return v;
+		}
+		// try the POM
+		final POM p = getPOM();
+		if (p != null) {
+			final String v = p.getVersion();
+			if (v != null) return v;
+		}
+		return "Unknown";
+	}
+
 }

src/main/java/org/scijava/plugin/AbstractRichPlugin.java

@@ -32,9 +32,7 @@
 package org.scijava.plugin;
 
 import org.scijava.AbstractContextual;
-import org.scijava.Prioritized;
 import org.scijava.Priority;
-import org.scijava.util.ClassUtils;
 
 /**
  * Abstract base class for {@link RichPlugin} implementations.
@@ -83,18 +81,4 @@ public void setInfo(final PluginInfo<?> info) {
 		this.info = info;
 	}
 
-	// -- Comparable methods --
-
-	@Override
-	public int compareTo(final Prioritized that) {
-		if (that == null) return 1;
-
-		// compare priorities
-		final int priorityCompare = Priority.compare(this, that);
-		if (priorityCompare != 0) return priorityCompare;
-
-		// compare classes
-		return ClassUtils.compare(getClass(), that.getClass());
-	}
-
 }

src/main/java/org/scijava/plugin/RichPlugin.java

@@ -32,7 +32,10 @@
 package org.scijava.plugin;
 
 import org.scijava.Contextual;
+import org.scijava.Identifiable;
+import org.scijava.Locatable;
 import org.scijava.Prioritized;
+import org.scijava.Versioned;
 
 /**
  * Base interface for {@link Contextual}, {@link Prioritized} plugins that
@@ -42,8 +45,15 @@
  * 
  * @author Curtis Rueden
  */
-public interface RichPlugin extends Contextual, Prioritized, HasPluginInfo,
-	SciJavaPlugin
+public interface RichPlugin extends SciJavaPlugin, Contextual, Prioritized,
+	HasPluginInfo, Identifiable, Locatable, Versioned
 {
-	// NB: Marker interface.
+
+	// -- Identifiable methods --
+
+	@Override
+	default String getIdentifier() {
+		return "plugin:" + getClass().getName();
+	}
+
 }

src/main/java/org/scijava/script/ScriptInfo.java

@@ -318,6 +318,8 @@ public String getLocation() {
 		return new File(path).toURI().normalize().toString();
 	}
 
+	// -- Versioned methods --
+
 	@Override
 	public String getVersion() {
 		final File file = new File(path);