Package org.apache.commons.configuration2.io

Class AbsoluteNameLocationStrategy

java.lang.Object
org.apache.commons.configuration2.io.AbsoluteNameLocationStrategy
All Implemented Interfaces:
FileLocationStrategy
public class AbsoluteNameLocationStrategy extends Object implements FileLocationStrategy

A specialized implementation of FileLocationStrategy which checks whether the provided file name is already an absolute file name.

This strategy ignores the URL and the base path stored in the passed in FileLocator. It is only triggered by absolute names in the locator's fileName component.

Since:
2.0

  • Constructor Details

  • Method Details

    • locate

      public URL locate(FileSystem fileSystem, FileLocator locator)
      Tries to locate the specified file. The method also expects the FileSystem to be used. Note that the FileLocator object may also contain a FileSystem, but this is optional. The passed in FileSystem should be used, and callers must not pass a null reference for this argument. A concrete implementation has to evaluate the properties stored in the FileLocator object 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 constructs a File object from the locator's file name (if defined). If this results in an absolute file name pointing to an existing file, the corresponding URL is returned.
      Specified by:
      locate in interface FileLocationStrategy
      Parameters:
      fileSystem - the FileSystem to be used for this operation
      locator - 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