Class ProvidedURLLocationStrategy
java.lang.Object
org.apache.commons.configuration2.io.ProvidedURLLocationStrategy
- All Implemented Interfaces:
FileLocationStrategy
A specialized implementation of FileLocationStrategy which checks whether a passed in FileLocator
already has a defined URL.
FileLocator objects that have a URL already reference a file in an unambiguous way. Therefore, this strategy
just returns the URL of the passed in FileLocator. It can be used as a first step of the file resolving
process. If it fails, more sophisticated attempts for resolving the file can be made.
- Since:
- 2.0
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlocate(FileSystem fileSystem, FileLocator locator) Tries to locate the specified file.
-
Constructor Details
-
ProvidedURLLocationStrategy
public ProvidedURLLocationStrategy()
-
-
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 just returns the URL stored in the givenFileLocator.- 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
-