Class BasePathLocationStrategy
java.lang.Object
org.apache.commons.configuration2.io.BasePathLocationStrategy
- All Implemented Interfaces:
FileLocationStrategy
A specialized implementation of FileLocationStrategy which tries to construct a file path from the locator's
base path and file name.
This strategies ignores the URL stored in the passed in FileLocator. It generates a path by concatenating the
base path (if present) and the file name. If the resulting path points to a valid file, the corresponding URL is
returned.
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlocate(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.
-
Constructor Details
-
BasePathLocationStrategy
public BasePathLocationStrategy()
-
-
Method Details
-
locate
Tries to locate the specified file. The method also expects theFileSystemto be used. Note that theFileLocatorobject may also contain aFileSystem, but this is optional. The passed inFileSystemshould be used, and callers must not pass a null reference for this argument. A concrete implementation has to evaluate the properties stored in theFileLocatorobject and try to match them to an existing file. If this can be done, a corresponding URL is returned. Otherwise, result is null. Implementations should not throw an exception (unless parameters are null) as there might be alternative strategies which can find the file in question. This implementation uses utility methods fromFileLocatorUtilsto generate aFilefrom the locator's base path and file name. If thisFileexists, its URL is returned.- Specified by:
locatein interfaceFileLocationStrategy- Parameters:
fileSystem- theFileSystemto be used for this operationlocator- the object describing the file to be located- Returns:
- a URL pointing to the referenced file if location was successful; null if the file could not be resolved
-