FileLocator

java.lang.Object
- com.github.rvesse.airline.parser.resources.FileLocator

All Implemented Interfaces:

ResourceLocator

Direct Known Subclasses:

AbstractPlaceholderLocator, HomeDirectoryLocator, WorkingDirectoryLocator
```
public class FileLocator
extends java.lang.Object
implements ResourceLocator
```
A resource locator that does no resolution other than removing any leading file:// prefix i.e. treats paths as literal files
Derived implementations can override the resolve(String) method to apply some interpretation of the location to resolve special paths, variable references etc.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String FILE_URI_PREFIX

Constructor Summary

Constructors
Constructor Description

FileLocator()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.io.InputStream`	`open(java.lang.String searchLocation, java.lang.String resourceName)`	Opens a search location, potentially applying some resolution rules to that location
`protected java.lang.String`	`resolve(java.lang.String searchLocation)`	Resolves the search location

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

- Field Detail
  - FILE_URI_PREFIX
```
public static final java.lang.String FILE_URI_PREFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileLocator
```
public FileLocator()
```
- Method Detail
  - resolve
```
protected java.lang.String resolve(java.lang.String searchLocation)
```
    Resolves the search location
    
    Parameters:
    
    searchLocation - Search location
    
    Returns:
    
    Resolved location
  - open
```
public java.io.InputStream open(java.lang.String searchLocation,
                                java.lang.String resourceName)
                         throws java.io.IOException
```
    Description copied from interface: ResourceLocator
    
    Opens a search location, potentially applying some resolution rules to that location
    If the given resourceName exists in the search location then that resource should be returned. If that is not a valid resource but the search location itself is a valid resource then the locator should return that instead.
    
    Specified by:
    
    open in interface ResourceLocator
    
    Parameters:
    
    searchLocation - Search location
    
    resourceName - Resource name expected in the search location
    
    Returns:
    
    Input stream to read the search location or null if not a valid location
    
    Throws:
    
    java.io.IOException - Thrown if there is a problem accessing the search location