FileLocation (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.io.location.AbstractLocation
- - org.scijava.io.location.FileLocation

All Implemented Interfaces:

BrowsableLocation, Location
```
public class FileLocation
extends AbstractLocation
implements BrowsableLocation
```
Location backed by a File on disk.

Author:

Curtis Rueden, Gabriel Einsdorf

Constructor Summary

Constructors
Constructor and Description

FileLocation(File file)

FileLocation(String path)

FileLocation(URI path)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FileLocation`	`child(String name)` Obtains a location with the given name, for whom this location is the parent.
`Set<BrowsableLocation>`	`children()` Obtains a collection of locations for whom this location is the parent.
`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.
`boolean`	`isDirectory()` Tests whether this location is a directory, meaning that it can have children.
`FileLocation`	`parent()` Obtains a location pointing to the parent directory of this one.
`FileLocation`	`sibling(String path)` Obtains a location relative to this one, which will be configured like the current location, but point to a the file specified by the `path` parameter.

Methods inherited from class org.scijava.io.location.AbstractLocation
equals, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.scijava.io.location.Location
defaultName

- 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.
    
    Specified by:
    
    getURI in interface Location
  - 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.
    
    Specified by:
    
    getName in interface Location
    
    Returns:
    
    The name, or an empty string if no name is available.
  - parent
```
public FileLocation parent()
                    throws IOException
```
    Description copied from interface: BrowsableLocation
    
    Obtains a location pointing to the parent directory of this one.
    
    Specified by:
    
    parent in interface BrowsableLocation
    
    Returns:
    
    the parent location of this one, or null if this location has no parent.
    
    Throws:
    
    IOException - if something goes wrong obtaining the parent.
  - children
```
public Set<BrowsableLocation> children()
                                throws IOException
```
    Description copied from interface: BrowsableLocation
    
    Obtains a collection of locations for whom this location is the parent. Note that this will only succeed if calls to BrowsableLocation.isDirectory() on this location return true.
    
    Specified by:
    
    children in interface BrowsableLocation
    
    Returns:
    
    A set containing the children of this location, or Collections.EMPTY_SET if this location has no children.
    
    Throws:
    
    IOException - if something goes wrong obtaining the children.
  - sibling
```
public FileLocation sibling(String path)
```
    Description copied from interface: BrowsableLocation
    
    Obtains a location relative to this one, which will be configured like the current location, but point to a the file specified by the path parameter.
    
    Specified by:
    
    sibling in interface BrowsableLocation
    
    Parameters:
    
    path - the relative path of the desired location.
    
    Returns:
    
    A location that points to the specified file location.
  - child
```
public FileLocation child(String name)
```
    Description copied from interface: BrowsableLocation
    
    Obtains a location with the given name, for whom this location is the parent. Note that this will only succeed if calls to BrowsableLocation.isDirectory() on this location return true.
    
    Specified by:
    
    child in interface BrowsableLocation
    
    Parameters:
    
    name - the name of the child
    
    Returns:
    
    a location pointing to the child
  - isDirectory
```
public boolean isDirectory()
```
    Description copied from interface: BrowsableLocation
    
    Tests whether this location is a directory, meaning that it can have children. It is recommended to use this method before calling BrowsableLocation.child(String) or BrowsableLocation.children(), to ensure those calls succeed.
    
    Specified by:
    
    isDirectory in interface BrowsableLocation
    
    Returns:
    
    True iff the location represents a directory.

Class FileLocation

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.io.location.Location

Constructor Detail

FileLocation

FileLocation

FileLocation

Method Detail

getFile

getURI

getName

parent

children

sibling

child

isDirectory