Interface ResourceLocator

All Known Implementing Classes:
AbstractPlaceholderLocator, ClasspathLocator, EnvVarLocator, FileLocator, HomeDirectoryLocator, JpmsResourceLocator, JvmSystemPropertyLocator, ModulePathLocator, WorkingDirectoryLocator
public interface ResourceLocator
Interface for making resource search locations extensible e.g. supporting special paths like ~/ to represent the home directory

  • Method Summary

    Modifier and Type
    Method
    Description
    InputStream
    open(String searchLocation, String resourceName)
    Opens a search location, potentially applying some resolution rules to that location

  • Method Details

    • open

      InputStream open(String searchLocation, String resourceName) throws IOException
      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.

      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:
      IOException - Thrown if there is a problem accessing the search location