We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 969cf3a commit 6c7aab8Copy full SHA for 6c7aab8
src/main/java/org/scijava/io/location/Location.java
@@ -61,8 +61,13 @@ default URI getURI() {
61
}
62
63
/**
64
- * Gets the name of the object addressed by this location, or an empty string
65
- * if it has no name.
+ * Gets a (typically short) name expressing this location. This string is not
+ * intended to unambiguously identify the location, but rather act as a
66
+ * friendly, human-readable name. The precise behavior will depend on the
67
+ * implementation, but as an example, a file-based location could return the
68
+ * name of the associated file without its full path.
69
+ *
70
+ * @return The name, or an empty string if no name is available.
71
*/
72
default String getName() {
73
final URI uri = getURI();
0 commit comments