Tool: move default method impls to iface

Author: ctrueden

src/main/java/org/scijava/tool/AbstractTool.java

@@ -31,15 +31,6 @@
 
 package org.scijava.tool;
 
-import org.scijava.display.event.input.KyPressedEvent;
-import org.scijava.display.event.input.KyReleasedEvent;
-import org.scijava.display.event.input.MsClickedEvent;
-import org.scijava.display.event.input.MsDraggedEvent;
-import org.scijava.display.event.input.MsMovedEvent;
-import org.scijava.display.event.input.MsPressedEvent;
-import org.scijava.display.event.input.MsReleasedEvent;
-import org.scijava.display.event.input.MsWheelEvent;
-import org.scijava.input.MouseCursor;
 import org.scijava.plugin.AbstractRichPlugin;
 
 /**
@@ -49,80 +40,5 @@
  * @author Grant Harris
  */
 public abstract class AbstractTool extends AbstractRichPlugin implements Tool {
-
-	@Override
-	public boolean isAlwaysActive() {
-		return false;
-	}
-
-	@Override
-	public boolean isActiveInAppFrame() {
-		return false;
-	}
-
-	@Override
-	public MouseCursor getCursor() {
-		return MouseCursor.DEFAULT;
-	}
-
-	@Override
-	public void activate() {
-		// do nothing by default
-	}
-
-	@Override
-	public void deactivate() {
-		// do nothing by default
-	}
-
-	@Override
-	public void onKeyDown(final KyPressedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onKeyUp(final KyReleasedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onMouseDown(final MsPressedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onMouseUp(final MsReleasedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onMouseClick(final MsClickedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onMouseMove(final MsMovedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onMouseDrag(final MsDraggedEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void onMouseWheel(final MsWheelEvent evt) {
-		// do nothing by default
-	}
-
-	@Override
-	public void configure() {
-		// do nothing by default
-	}
-
-	@Override
-	public String getDescription() {
-		return getInfo().getDescription();
-	}
-
+	// NB: No implementation needed.
 }

src/main/java/org/scijava/tool/Tool.java

@@ -69,51 +69,88 @@
 public interface Tool extends RichPlugin, SingletonPlugin {
 
 	/** When true, tool has no button but rather is active all the time. */
-	boolean isAlwaysActive();
+	default boolean isAlwaysActive() {
+		return false;
+	}
 
 	/**
 	 * When true, tool receives events when the main application frame is active.
 	 * When false, tool only receives events when a display window is active.
 	 */
-	boolean isActiveInAppFrame();
+	default boolean isActiveInAppFrame() {
+		return false;
+	}
 
 	/** The tool's mouse pointer. */
-	MouseCursor getCursor();
+	default MouseCursor getCursor() {
+		return MouseCursor.DEFAULT;
+	}
 
 	/** Informs the tool that it is now active. */
-	void activate();
+	default void activate() {
+		// do nothing by default
+	}
 
 	/** Informs the tool that it is no longer active. */
-	void deactivate();
+	default void deactivate() {
+		// do nothing by default
+	}
 
 	/** Occurs when a key on the keyboard is pressed while the tool is active. */
-	void onKeyDown(KyPressedEvent event);
+	@SuppressWarnings("unused")
+	default void onKeyDown(final KyPressedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when a key on the keyboard is released while the tool is active. */
-	void onKeyUp(KyReleasedEvent event);
+	@SuppressWarnings("unused")
+	default void onKeyUp(final KyReleasedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when a mouse button is pressed while the tool is active. */
-	void onMouseDown(MsPressedEvent event);
+	@SuppressWarnings("unused")
+	default void onMouseDown(final MsPressedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when a mouse button is released while the tool is active. */
-	void onMouseUp(MsReleasedEvent event);
+	@SuppressWarnings("unused")
+	default void onMouseUp(final MsReleasedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when a mouse button is double clicked while the tool is active. */
-	void onMouseClick(MsClickedEvent event);
+	@SuppressWarnings("unused")
+	default void onMouseClick(final MsClickedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when the mouse is moved while the tool is active. */
-	void onMouseMove(MsMovedEvent event);
+	@SuppressWarnings("unused")
+	default void onMouseMove(final MsMovedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when the mouse is dragged while the tool is active. */
-	void onMouseDrag(MsDraggedEvent event);
+	@SuppressWarnings("unused")
+	default void onMouseDrag(final MsDraggedEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when the mouse wheel is moved while the tool is active. */
-	void onMouseWheel(MsWheelEvent event);
+	@SuppressWarnings("unused")
+	default void onMouseWheel(final MsWheelEvent evt) {
+		// do nothing by default
+	}
 
 	/** Occurs when the user right clicks this tool's icon. */
-	void configure();
+	default void configure() {
+		// do nothing by default
+	}
 
 	/** Returns the text the tool provides when mouse hovers over tool */
-	String getDescription();
-
+	default String getDescription() {
+		return getInfo().getDescription();
+	}
 }