Merge branch 'initializable'

This migrates the Initializable interface, formerly part of ImageJ Ops,
here to core SciJava Common, since it is probably generally useful.

Author: ctrueden

pom.xml

@@ -10,7 +10,7 @@
 	</parent>
 
 	<artifactId>scijava-common</artifactId>
-	<version>2.61.1-SNAPSHOT</version>
+	<version>2.62.0-SNAPSHOT</version>
 
 	<name>SciJava Common</name>
 	<description>SciJava Common is a shared library for SciJava software. It provides a plugin framework, with an extensible mechanism for service discovery, backed by its own annotation processor, so that plugins can be loaded dynamically. It is used by downstream projects in the SciJava ecosystem, such as ImageJ and SCIFIO.</description>

src/main/java/org/scijava/Initializable.java

@@ -0,0 +1,45 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2016 Board of Regents of the University of
+ * Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
+ * Institute of Molecular Cell Biology and Genetics.
+ * %%
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * #L%
+ */
+
+package org.scijava;
+
+/**
+ * Interface for objects which can be initialized.
+ * 
+ * @author Curtis Rueden
+ */
+public interface Initializable {
+
+	/** Initializes the object. */
+	default void initialize() {
+		// NB: Do nothing by default.
+	}
+}

src/main/java/org/scijava/service/Service.java

@@ -32,6 +32,7 @@
 package org.scijava.service;
 
 import org.scijava.Disposable;
+import org.scijava.Initializable;
 import org.scijava.event.EventService;
 import org.scijava.plugin.Plugin;
 import org.scijava.plugin.RichPlugin;
@@ -49,34 +50,36 @@
  * @author Curtis Rueden
  * @see Plugin
  */
-public interface Service extends RichPlugin, Disposable {
+public interface Service extends RichPlugin, Initializable, Disposable {
 
 	/**
-	 * Performs any needed initialization when the service is first loaded.
+	 * Registers the service's event handler methods.
 	 * <p>
 	 * NB: This method is not intended to be called directly. It is called by
 	 * the service framework itself (specifically by the {@link ServiceHelper})
 	 * when initializing the service. It should not be called a second time.
 	 * </p>
 	 */
-	default void initialize() {
-		// NB: Do nothing by default.
+	default void registerEventHandlers() {
+		// TODO: Consider removing this method in scijava-common 3.0.0.
+		// Instead, the ServiceHelper could just invoke the lines below directly,
+		// and there would be one less boilerplate Service method to implement.
+		final EventService eventService = context().getService(EventService.class);
+		if (eventService != null) eventService.subscribe(this);
 	}
 
+	// -- Initializable methods --
+
 	/**
-	 * Registers the service's event handler methods.
+	 * Performs any needed initialization when the service is first loaded.
 	 * <p>
 	 * NB: This method is not intended to be called directly. It is called by
 	 * the service framework itself (specifically by the {@link ServiceHelper})
 	 * when initializing the service. It should not be called a second time.
 	 * </p>
 	 */
-	default void registerEventHandlers() {
-		// TODO: Consider removing this method in scijava-common 3.0.0.
-		// Instead, the ServiceHelper could just invoke the lines below directly,
-		// and there would be one less boilerplate Service method to implement.
-		final EventService eventService = context().getService(EventService.class);
-		if (eventService != null) eventService.subscribe(this);
+	@Override
+	default void initialize() {
+		// NB: Do nothing by default.
 	}
-
 }