Skip to content

Commit 6c7aab8

Browse files
committed
Location: improve javadoc of getName() method
1 parent 969cf3a commit 6c7aab8

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/main/java/org/scijava/io/location/Location.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,13 @@ default URI getURI() {
6161
}
6262

6363
/**
64-
* Gets the name of the object addressed by this location, or an empty string
65-
* if it has no name.
64+
* Gets a (typically short) name expressing this location. This string is not
65+
* 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.
6671
*/
6772
default String getName() {
6873
final URI uri = getURI();

0 commit comments

Comments
 (0)