Merge branch 'named'

Add a Named interface for things with names.

This was originally part of the imglib2-meta project (and later migrated
to imagej-common as a deprecated class). But it really fits best here in
the SciJava Common library.

Author: ctrueden

src/main/java/org/scijava/AbstractBasicDetails.java

@@ -71,11 +71,6 @@ public String toString() {
 
 	// -- BasicDetails methods --
 
-	@Override
-	public String getName() {
-		return name;
-	}
-
 	@Override
 	public String getLabel() {
 		return label;
@@ -96,11 +91,6 @@ public String get(final String key) {
 		return values.get(key);
 	}
 
-	@Override
-	public void setName(final String name) {
-		this.name = name;
-	}
-
 	@Override
 	public void setLabel(final String label) {
 		this.label = label;
@@ -116,4 +106,16 @@ public void set(String key, String value) {
 		values.put(key, value);
 	}
 
+	// -- Named methods --
+
+	@Override
+	public String getName() {
+		return name;
+	}
+
+	@Override
+	public void setName(final String name) {
+		this.name = name;
+	}
+
 }

src/main/java/org/scijava/BasicDetails.java

@@ -37,10 +37,7 @@
  * 
  * @author Curtis Rueden
  */
-public interface BasicDetails {
-
-	/** Gets the unique name of the object. */
-	String getName();
+public interface BasicDetails extends Named {
 
 	/** Gets the name to appear in a UI, if applicable. */
 	String getLabel();
@@ -54,9 +51,6 @@ public interface BasicDetails {
 	/** Gets the value of the given key, or null if undefined. */
 	public String get(String key);
 
-	/** Sets the unique name of the object. */
-	void setName(String name);
-
 	/** Sets the name to appear in a UI, if applicable. */
 	void setLabel(String label);
 

src/main/java/org/scijava/MenuEntry.java

@@ -39,7 +39,7 @@
  * @author Curtis Rueden
  * @author Johannes Schindelin
  */
-public class MenuEntry {
+public class MenuEntry implements Named {
 
 	public static final double DEFAULT_WEIGHT = Double.POSITIVE_INFINITY;
 
@@ -68,14 +68,6 @@ public MenuEntry(final String name, final double weight,
 		setIconPath(iconPath);
 	}
 
-	public void setName(final String name) {
-		this.name = name;
-	}
-
-	public String getName() {
-		return name;
-	}
-
 	public void setWeight(final double weight) {
 		this.weight = weight;
 	}
@@ -120,6 +112,20 @@ public void assignProperties(final MenuEntry entry) {
 		if (iconPath == null) iconPath = entry.getIconPath();
 	}
 
+	// -- Named methods --
+
+	@Override
+	public String getName() {
+		return name;
+	}
+
+	@Override
+	public void setName(final String name) {
+		this.name = name;
+	}
+
+	// -- Object methods --
+
 	@Override
 	public String toString() {
 		return name;

src/main/java/org/scijava/Named.java

@@ -0,0 +1,47 @@
+/*
+ * #%L
+ * SciJava Common shared library for SciJava software.
+ * %%
+ * Copyright (C) 2009 - 2014 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 things that have names.
+ * 
+ * @author Lee Kamentsky
+ */
+public interface Named {
+
+	/** Gets the name of the object. */
+	String getName();
+
+	/** Sets the name of the object. */
+	void setName(String name);
+
+}

src/main/java/org/scijava/command/CommandModuleItem.java

@@ -167,11 +167,6 @@ public List<T> getChoices() {
 
 	// -- BasicDetails methods --
 
-	@Override
-	public String getName() {
-		return field.getName();
-	}
-
 	@Override
 	public String getLabel() {
 		return getParameter().label();
@@ -198,4 +193,11 @@ public String get(final String key) {
 		return null;
 	}
 
+	// -- Named methods --
+
+	@Override
+	public String getName() {
+		return field.getName();
+	}
+
 }

src/main/java/org/scijava/command/DynamicCommandInfo.java

@@ -248,11 +248,6 @@ public void setSelected(final boolean selected) {
 
 	// -- BasicDetails methods --
 
-	@Override
-	public String getName() {
-		return info.getName();
-	}
-
 	@Override
 	public String getLabel() {
 		return info.getLabel();
@@ -263,11 +258,6 @@ public String getDescription() {
 		return info.getDescription();
 	}
 
-	@Override
-	public void setName(final String name) {
-		info.setName(name);
-	}
-
 	@Override
 	public void setLabel(final String label) {
 		info.setLabel(label);
@@ -278,6 +268,18 @@ public void setDescription(final String description) {
 		info.setDescription(description);
 	}
 
+	// -- Named methods --
+
+	@Override
+	public String getName() {
+		return info.getName();
+	}
+
+	@Override
+	public void setName(final String name) {
+		info.setName(name);
+	}
+
 	// -- Validated methods --
 
 	@Override

src/main/java/org/scijava/display/AbstractDisplay.java

@@ -150,6 +150,8 @@ public void close() {
 		isClosed = true;
 	}
 
+	// -- Named methods --
+
 	@Override
 	public String getName() {
 		return name;

src/main/java/org/scijava/display/Display.java

@@ -33,6 +33,7 @@
 
 import java.util.List;
 
+import org.scijava.Named;
 import org.scijava.plugin.Plugin;
 import org.scijava.plugin.RichPlugin;
 
@@ -52,7 +53,7 @@
  * @see Plugin
  * @see DisplayService
  */
-public interface Display<T> extends List<T>, RichPlugin {
+public interface Display<T> extends List<T>, RichPlugin, Named {
 
 	/**
 	 * Tests whether the display is capable of visualizing objects of the given
@@ -99,10 +100,4 @@ public interface Display<T> extends List<T>, RichPlugin {
 	/** Closes the display and disposes its resources. */
 	void close();
 
-	/** Gets the name of the display. */
-	String getName();
-
-	/** Sets the name of the display. */
-	void setName(String name);
-
 }

src/main/java/org/scijava/menu/ShadowMenu.java

@@ -45,6 +45,7 @@
 import org.scijava.Context;
 import org.scijava.MenuEntry;
 import org.scijava.MenuPath;
+import org.scijava.Named;
 import org.scijava.event.EventService;
 import org.scijava.log.LogService;
 import org.scijava.menu.event.MenusAddedEvent;
@@ -79,7 +80,7 @@
  * @see MenuEntry
  */
 public class ShadowMenu extends AbstractContextual implements
-	Comparable<ShadowMenu>, Collection<ModuleInfo>, Runnable
+	Comparable<ShadowMenu>, Collection<ModuleInfo>, Runnable, Named
 {
 
 	/** Icon to use for leaf entries by default, if no icon is specified. */
@@ -177,11 +178,6 @@ public int getMenuDepth() {
 		return menuDepth;
 	}
 
-	/** Gets the name of the menu. */
-	public String getName() {
-		return menuEntry == null ? null : menuEntry.getName();
-	}
-
 	/** Gets this node's parent, or null if it is a root node. */
 	public ShadowMenu getParent() {
 		return parent;
@@ -279,6 +275,19 @@ public boolean updateAll(final Collection<? extends ModuleInfo> c) {
 		return true;
 	}
 
+	// -- Named methods --
+
+	@Override
+	public String getName() {
+		return menuEntry == null ? null : menuEntry.getName();
+	}
+
+	@Override
+	public void setName(final String name) {
+		if (menuEntry == null) return;
+		menuEntry.setName(name);
+	}
+
 	// -- Object methods --
 
 	@Override

src/main/java/org/scijava/module/DefaultMutableModuleItem.java

@@ -296,11 +296,6 @@ public List<T> getChoices() {
 
 	// -- BasicDetails methods --
 
-	@Override
-	public String getName() {
-		return name;
-	}
-
 	@Override
 	public String getLabel() {
 		return label;
@@ -311,11 +306,6 @@ public String getDescription() {
 		return description;
 	}
 
-	@Override
-	public void setName(final String name) {
-		this.name = name;
-	}
-
 	@Override
 	public void setLabel(final String label) {
 		this.label = label;
@@ -326,4 +316,16 @@ public void setDescription(final String description) {
 		this.description = description;
 	}
 
+	// -- Named methods --
+
+	@Override
+	public String getName() {
+		return name;
+	}
+
+	@Override
+	public void setName(final String name) {
+		this.name = name;
+	}
+
 }