org.scijava.io.location

Class FileLocation

java.lang.Object

org.scijava.io.location.AbstractLocation

org.scijava.io.location.FileLocation

All Implemented Interfaces:

Location

public class FileLocation
extends AbstractLocation

Location backed by a File on disk.

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
FileLocation(File file)
FileLocation(String path)
FileLocation(URI path)

Method Summary

Modifier and Type	Method and Description
File	getFile() Gets the associated File.
String	getName() Gets a (typically short) name expressing this location.
URI	getURI() Gets the location expressed as a URI, or null if the location cannot be expressed as such.

Methods inherited from class org.scijava.io.location.AbstractLocation

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileLocation

public FileLocation(File file)

FileLocation

public FileLocation(String path)

FileLocation

public FileLocation(URI path)

Method Detail

getFile

public File getFile()

Gets the associated File.

getURI

public URI getURI()

Description copied from interface: Location

Gets the location expressed as a URI, or null if the location cannot be expressed as such.

getName

public String getName()

Description copied from interface: Location

Gets a (typically short) name expressing this location. This string is not intended to unambiguously identify the location, but rather act as a friendly, human-readable name. The precise behavior will depend on the implementation, but as an example, a file-based location could return the name of the associated file without its full path.

Returns:

The name, or an empty string if no name is available.