Rename get*Service() methods of services

ctrueden · ctrueden · commit 075f96dc2902 · 2016-08-18T14:26:30.000-05:00
As we move toward SJC3, I decided to drop the "get" prefix from service
dependency accessors. This is arguably inconsistent with the rest of
SJC, and certainly it is inconsistent with the Java standard library.
However, it has some nice consequences:

* When browsing available service functionality via autocomplete,
  service accessors do not clutter the accessors method list.
* It makes chaining service accessors more streamlined and readable.

I debated dropping the "Service" suffix too, in the same manner as the
Gateways do, but decided that would be confusing at the lower level of
the API where services reside: services have other API mixed in, so a
method called e.g. object() might be confused for something which
returns relevant objects, rather than an ObjectService instance.
The Gateways do not have this issue because their primary accessors
are in fact all services, so the naming is less confusing there.
diff --git a/src/main/java/org/scijava/command/CommandService.java b/src/main/java/org/scijava/command/CommandService.java
@@ -64,9 +64,9 @@
  */
 public interface CommandService extends PTService<Command>, SciJavaService {
 
-	EventService getEventService();
+	EventService eventService();
 
-	ModuleService getModuleService();
+	ModuleService moduleService();
 
 	/** Gets the list of all available {@link Command}s). */
 	List<CommandInfo> getCommands();
@@ -257,4 +257,17 @@ <C extends Command> Future<CommandModule> run(Class<C> commandClass,
 	Future<CommandModule> run(CommandInfo info, boolean process,
 		Map<String, Object> inputMap);
 
+	// -- Deprecated methods --
+
+	/** @deprecated Use {@link #eventService()} instead. */
+	@Deprecated
+	default EventService getEventService() {
+		return eventService();
+	}
+
+	/** @deprecated Use {@link #moduleService()} instead. */
+	@Deprecated
+	default ModuleService getModuleService() {
+		return moduleService();
+	}
 }
diff --git a/src/main/java/org/scijava/command/DefaultCommandService.java b/src/main/java/org/scijava/command/DefaultCommandService.java
@@ -83,17 +83,17 @@ public class DefaultCommandService extends AbstractPTService<Command> implements
 	// -- CommandService methods --
 
 	@Override
-	public EventService getEventService() {
+	public EventService eventService() {
 		return eventService;
 	}
 
 	@Override
-	public PluginService getPluginService() {
+	public PluginService pluginService() {
 		return pluginService;
 	}
 
 	@Override
-	public ModuleService getModuleService() {
+	public ModuleService moduleService() {
 		return moduleService;
 	}
 
diff --git a/src/main/java/org/scijava/display/DefaultDisplayService.java b/src/main/java/org/scijava/display/DefaultDisplayService.java
@@ -85,17 +85,17 @@ public final class DefaultDisplayService extends AbstractService implements
 	// -- DisplayService methods --
 
 	@Override
-	public EventService getEventService() {
+	public EventService eventService() {
 		return eventService;
 	}
 
 	@Override
-	public ObjectService getObjectService() {
+	public ObjectService objectService() {
 		return objectService;
 	}
 
 	@Override
-	public PluginService getPluginService() {
+	public PluginService pluginService() {
 		return pluginService;
 	}
 
diff --git a/src/main/java/org/scijava/display/DisplayService.java b/src/main/java/org/scijava/display/DisplayService.java
@@ -50,11 +50,11 @@
  */
 public interface DisplayService extends SciJavaService {
 
-	EventService getEventService();
+	EventService eventService();
 
-	ObjectService getObjectService();
+	ObjectService objectService();
 
-	PluginService getPluginService();
+	PluginService pluginService();
 
 	/** Gets the currently active display (of any Display type). */
 	Display<?> getActiveDisplay();
@@ -183,4 +183,23 @@ <DT extends Display<?>> List<PluginInfo<DT>> getDisplayPluginsOfType(
 	 */
 	Display<?> createDisplayQuietly(Object o);
 
+	// -- Deprecated methods --
+
+	/** @deprecated Use {@link #eventService()} instead. */
+	@Deprecated
+	default EventService getEventService() {
+		return eventService();
+	}
+
+	/** @deprecated Use {@link #objectService()} instead. */
+	@Deprecated
+	default ObjectService getObjectService() {
+		return objectService();
+	}
+
+	/** @deprecated Use {@link #pluginService()} instead. */
+	@Deprecated
+	default PluginService getPluginService() {
+		return pluginService();
+	}
 }
diff --git a/src/main/java/org/scijava/input/DefaultInputService.java b/src/main/java/org/scijava/input/DefaultInputService.java
@@ -79,7 +79,7 @@ public class DefaultInputService extends AbstractService implements
 	// -- InputService methods --
 
 	@Override
-	public EventService getEventService() {
+	public EventService eventService() {
 		return eventService;
 	}
 
diff --git a/src/main/java/org/scijava/input/InputService.java b/src/main/java/org/scijava/input/InputService.java
@@ -45,7 +45,7 @@
  */
 public interface InputService extends SciJavaService {
 
-	EventService getEventService();
+	EventService eventService();
 
 	InputModifiers getModifiers();
 
@@ -98,4 +98,11 @@ public interface InputService extends SciJavaService {
 	 */
 	boolean isButtonDown(int button);
 
+	// -- Deprecated methods --
+
+	/** @deprecated Use {@link #eventService()} instead. */
+	@Deprecated
+	default EventService getEventService() {
+		return eventService();
+	}
 }
diff --git a/src/main/java/org/scijava/object/DefaultObjectService.java b/src/main/java/org/scijava/object/DefaultObjectService.java
@@ -72,7 +72,7 @@ public final class DefaultObjectService extends AbstractService implements
 	// -- ObjectService methods --
 
 	@Override
-	public EventService getEventService() {
+	public EventService eventService() {
 		return eventService;
 	}
 
diff --git a/src/main/java/org/scijava/object/ObjectService.java b/src/main/java/org/scijava/object/ObjectService.java
@@ -43,7 +43,7 @@
  */
 public interface ObjectService extends SciJavaService {
 
-	EventService getEventService();
+	EventService eventService();
 
 	/** Gets the index of available objects. */
 	ObjectIndex<Object> getIndex();
@@ -57,4 +57,11 @@ public interface ObjectService extends SciJavaService {
 	/** Deregisters an object with the object service. */
 	void removeObject(Object obj);
 
+	// -- Deprecated methods --
+
+	/** @deprecated Use {@link #eventService()} instead. */
+	@Deprecated
+	default EventService getEventService() {
+		return eventService();
+	}
 }
diff --git a/src/main/java/org/scijava/platform/DefaultPlatformService.java b/src/main/java/org/scijava/platform/DefaultPlatformService.java
@@ -75,12 +75,12 @@ public final class DefaultPlatformService extends
 	// -- PlatformService methods --
 
 	@Override
-	public EventService getEventService() {
+	public EventService eventService() {
 		return eventService;
 	}
 
 	@Override
-	public CommandService getCommandService() {
+	public CommandService commandService() {
 		return commandService;
 	}
 
diff --git a/src/main/java/org/scijava/platform/PlatformService.java b/src/main/java/org/scijava/platform/PlatformService.java
@@ -52,9 +52,9 @@ public interface PlatformService extends SingletonService<Platform>,
 	SciJavaService
 {
 
-	EventService getEventService();
+	EventService eventService();
 
-	CommandService getCommandService();
+	CommandService commandService();
 
 	/** Gets the platform handlers applicable to this platform. */
 	List<Platform> getTargetPlatforms();
@@ -90,4 +90,16 @@ public interface PlatformService extends SingletonService<Platform>,
 	/** @deprecated Use {@link AppService} and {@link App} instead. */
 	@Deprecated
 	AppEventService getAppEventService();
+
+	/** @deprecated Use {@link #eventService()} instead. */
+	@Deprecated
+	default EventService getEventService() {
+		return eventService();
+	}
+
+	/** @deprecated Use {@link #commandService()} instead. */
+	@Deprecated
+	default CommandService getCommandService() {
+		return commandService();
+	}
 }
diff --git a/src/main/java/org/scijava/plugin/AbstractPTService.java b/src/main/java/org/scijava/plugin/AbstractPTService.java
@@ -51,7 +51,7 @@ public abstract class AbstractPTService<PT extends SciJavaPlugin> extends
 	// -- PTService methods --
 
 	@Override
-	public PluginService getPluginService() {
+	public PluginService pluginService() {
 		return pluginService;
 	}
 
diff --git a/src/main/java/org/scijava/plugin/AbstractSingletonService.java b/src/main/java/org/scijava/plugin/AbstractSingletonService.java
@@ -120,9 +120,8 @@ protected List<? extends PT> filterInstances(final List<PT> list) {
 	private synchronized void initInstances() {
 		if (instances != null) return;
 
-		final List<PT> list =
-			Collections.unmodifiableList(filterInstances(getPluginService()
-				.createInstancesOfType(getPluginType())));
+		final List<PT> list = Collections.unmodifiableList(filterInstances(
+			pluginService().createInstancesOfType(getPluginType())));
 
 		final HashMap<Class<? extends PT>, PT> map =
 			new HashMap<>();
diff --git a/src/main/java/org/scijava/plugin/AbstractWrapperService.java b/src/main/java/org/scijava/plugin/AbstractWrapperService.java
@@ -77,7 +77,7 @@ public boolean supports(final DT data) {
 
 	private <D extends DT> PT findWrapper(final D data) {
 		for (final PluginInfo<PT> plugin : getPlugins()) {
-			final PT instance = getPluginService().createInstance(plugin);
+			final PT instance = pluginService().createInstance(plugin);
 			if (instance != null && instance.supports(data)) return instance;
 		}
 		return null;
diff --git a/src/main/java/org/scijava/plugin/PTService.java b/src/main/java/org/scijava/plugin/PTService.java
@@ -87,7 +87,7 @@ public interface PTService<PT extends SciJavaPlugin> extends Service {
 	 * Gets the service responsible for discovering and managing this service's
 	 * plugins.
 	 */
-	PluginService getPluginService();
+	PluginService pluginService();
 
 	/** Gets the plugins managed by this service. */
 	List<PluginInfo<PT>> getPlugins();
@@ -98,4 +98,11 @@ public interface PTService<PT extends SciJavaPlugin> extends Service {
 	/** Creates an instance of the given plugin class. */
 	<P extends PT> P create(final Class<P> pluginClass);
 
+	// -- Deprecated methods --
+
+	/** @deprecated Use {@link #pluginService()} instead. */
+	@Deprecated
+	default PluginService getPluginService() {
+		return pluginService();
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -83,17 +83,17 @@ public class DefaultCommandService extends AbstractPTService<Command> implements`
`83`	`83`	`// -- CommandService methods --`
`84`	`84`
`85`	`85`	`@Override`
`86`		`- public EventService getEventService() {`
	`86`	`+ public EventService eventService() {`
`87`	`87`	`return eventService;`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`@Override`
`91`		`- public PluginService getPluginService() {`
	`91`	`+ public PluginService pluginService() {`
`92`	`92`	`return pluginService;`
`93`	`93`	`}`
`94`	`94`
`95`	`95`	`@Override`
`96`		`- public ModuleService getModuleService() {`
	`96`	`+ public ModuleService moduleService() {`
`97`	`97`	`return moduleService;`
`98`	`98`	`}`
`99`	`99`
Original file line number	Diff line number	Diff line change
`@@ -85,17 +85,17 @@ public final class DefaultDisplayService extends AbstractService implements`
`85`	`85`	`// -- DisplayService methods --`
`86`	`86`
`87`	`87`	`@Override`
`88`		`- public EventService getEventService() {`
	`88`	`+ public EventService eventService() {`
`89`	`89`	`return eventService;`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`@Override`
`93`		`- public ObjectService getObjectService() {`
	`93`	`+ public ObjectService objectService() {`
`94`	`94`	`return objectService;`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`@Override`
`98`		`- public PluginService getPluginService() {`
	`98`	`+ public PluginService pluginService() {`
`99`	`99`	`return pluginService;`
`100`	`100`	`}`
`101`	`101`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public class DefaultInputService extends AbstractService implements`
`79`	`79`	`// -- InputService methods --`
`80`	`80`
`81`	`81`	`@Override`
`82`		`- public EventService getEventService() {`
	`82`	`+ public EventService eventService() {`
`83`	`83`	`return eventService;`
`84`	`84`	`}`
`85`	`85`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ public final class DefaultObjectService extends AbstractService implements`
`72`	`72`	`// -- ObjectService methods --`
`73`	`73`
`74`	`74`	`@Override`
`75`		`- public EventService getEventService() {`
	`75`	`+ public EventService eventService() {`
`76`	`76`	`return eventService;`
`77`	`77`	`}`
`78`	`78`
Original file line number	Diff line number	Diff line change
`@@ -75,12 +75,12 @@ public final class DefaultPlatformService extends`
`75`	`75`	`// -- PlatformService methods --`
`76`	`76`
`77`	`77`	`@Override`
`78`		`- public EventService getEventService() {`
	`78`	`+ public EventService eventService() {`
`79`	`79`	`return eventService;`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`@Override`
`83`		`- public CommandService getCommandService() {`
	`83`	`+ public CommandService commandService() {`
`84`	`84`	`return commandService;`
`85`	`85`	`}`
`86`	`86`