Warn on service failure, debug stack trace

hinerm · hinerm · commit 4d226ba86d2b · 2013-03-19T10:08:28.000-05:00
When a service fails to load in the ServiceHelper, it now issues a one
line warning message instead of an "error" with a full stack trace. The
stack trace is instead logged to debug.

The goal was to reduce the standard output, and avoid confusion over the
error message as program execution isn't actually halted by failing to
load a service.
diff --git a/src/main/java/org/scijava/service/ServiceHelper.java b/src/main/java/org/scijava/service/ServiceHelper.java
@@ -152,15 +152,16 @@ public <S extends Service> S loadService(final Class<S> c) {
 	 *         instantiated
 	 */
 	public <S extends Service> S createExactService(final Class<S> c) {
-		debug("Creating service: " + c.getName());
+		debug("Creating service: " + c.getName(), null);
 		try {
 			final S service = createService(c);
 			getContext().getServiceIndex().add(service);
 			info("Created service: " + c.getName());
 			return service;
 		}
 		catch (final Throwable t) {
-			error("Invalid service: " + c.getName(), t);
+			warn("Invalid service: " + c.getName());
+			debug("Invalid service: " + c.getName(), t);
 		}
 		return null;
 	}
@@ -229,6 +230,12 @@ private void info(final String msg) {
 		final LogService log = getContext().getService(LogService.class);
 		if (log != null) log.info(msg);
 	}
+	
+	/** Logs the given warning, if a {@link LogService} is available. */ 
+	private void warn(final String msg) {
+		final LogService log = getContext().getService(LogService.class);
+		if (log != null) log.warn(msg);
+	}
 
 	/** Logs the given error, if a {@link LogService} is available. */
 	private void error(final String msg, final Throwable t) {
@@ -237,9 +244,9 @@ private void error(final String msg, final Throwable t) {
 	}
 
 	/** Logs the given debug message, if a {@link LogService} is available. */
-	private void debug(final String msg) {
+	private void debug(final String msg, final Throwable t) {
 		final LogService log = getContext().getService(LogService.class);
-		if (log != null) log.debug(msg);
+		if (log != null) log.debug(msg, t);
 	}
 
 }

Original file line number	Diff line number	Diff line change
`@@ -152,15 +152,16 @@ public <S extends Service> S loadService(final Class<S> c) {`
`152`	`152`	`* instantiated`
`153`	`153`	`*/`
`154`	`154`	`public <S extends Service> S createExactService(final Class<S> c) {`
`155`		`- debug("Creating service: " + c.getName());`
	`155`	`+ debug("Creating service: " + c.getName(), null);`
`156`	`156`	`try {`
`157`	`157`	`final S service = createService(c);`
`158`	`158`	`getContext().getServiceIndex().add(service);`
`159`	`159`	`info("Created service: " + c.getName());`
`160`	`160`	`return service;`
`161`	`161`	`}`
`162`	`162`	`catch (final Throwable t) {`
`163`		`- error("Invalid service: " + c.getName(), t);`
	`163`	`+ warn("Invalid service: " + c.getName());`
	`164`	`+ debug("Invalid service: " + c.getName(), t);`
`164`	`165`	`}`
`165`	`166`	`return null;`
`166`	`167`	`}`
`@@ -229,6 +230,12 @@ private void info(final String msg) {`
`229`	`230`	`final LogService log = getContext().getService(LogService.class);`
`230`	`231`	`if (log != null) log.info(msg);`
`231`	`232`	`}`
	`233`	`+`
	`234`	`+ /** Logs the given warning, if a {@link LogService} is available. */`
	`235`	`+ private void warn(final String msg) {`
	`236`	`+ final LogService log = getContext().getService(LogService.class);`
	`237`	`+ if (log != null) log.warn(msg);`
	`238`	`+ }`
`232`	`239`
`233`	`240`	`/** Logs the given error, if a {@link LogService} is available. */`
`234`	`241`	`private void error(final String msg, final Throwable t) {`
`@@ -237,9 +244,9 @@ private void error(final String msg, final Throwable t) {`
`237`	`244`	`}`
`238`	`245`
`239`	`246`	`/** Logs the given debug message, if a {@link LogService} is available. */`
`240`		`- private void debug(final String msg) {`
	`247`	`+ private void debug(final String msg, final Throwable t) {`
`241`	`248`	`final LogService log = getContext().getService(LogService.class);`
`242`		`- if (log != null) log.debug(msg);`
	`249`	`+ if (log != null) log.debug(msg, t);`
`243`	`250`	`}`
`244`	`251`
`245`	`252`	`}`