org.springframework.core.io.support

Interface ResourcePatternResolver

  • All Superinterfaces:
    ResourceLoader
    All Known Implementing Classes:
    PathMatchingResourcePatternResolver

    public interface ResourcePatternResolver
    extends ResourceLoader
    Strategy interface for resolving a location pattern (for example, an Ant-style path pattern) into Resource objects.

    This is an extension to the ResourceLoader interface. A passed-in ResourceLoader (for example, an org.springframework.context.ApplicationContext passed in via org.springframework.context.ResourceLoaderAware when running in a context) can be checked whether it implements this extended interface too.

    PathMatchingResourcePatternResolver is a standalone implementation that is usable outside an ApplicationContext, also used by ResourceArrayPropertyEditor for populating Resource array bean properties.

    Can be used with any sort of location pattern (e.g. "/WEB-INF/*-context.xml"): Input patterns have to match the strategy implementation. This interface just specifies the conversion method rather than a specific pattern format.

    This interface also suggests a new resource prefix "classpath*:" for all matching resources from the class path. Note that the resource location is expected to be a path without placeholders in this case (e.g. "/beans.xml"); JAR files or classes directories can contain multiple files of the same name.

    Since:
    1.0.2
    Author:
    Juergen Hoeller
    See Also:
    Resource, ResourceLoader, org.springframework.context.ApplicationContext, org.springframework.context.ResourceLoaderAware
    • Field Summary

      Fields  
      Modifier and Type Field and Description
      static String CLASSPATH_ALL_URL_PREFIX
      Pseudo URL prefix for all matching resources from the class path: "classpath*:" This differs from ResourceLoader's classpath URL prefix in that it retrieves all matching resources for a given name (e.g.
    • Field Detail

      • CLASSPATH_ALL_URL_PREFIX

        static final String CLASSPATH_ALL_URL_PREFIX
        Pseudo URL prefix for all matching resources from the class path: "classpath*:" This differs from ResourceLoader's classpath URL prefix in that it retrieves all matching resources for a given name (e.g. "/beans.xml"), for example in the root of all deployed JAR files.
        See Also:
        ResourceLoader.CLASSPATH_URL_PREFIX, Constant Field Values
    • Method Detail

      • getResources

        Resource[] getResources(String locationPattern)
                                throws IOException
        Resolve the given location pattern into Resource objects.

        Overlapping resource entries that point to the same physical resource should be avoided, as far as possible. The result should have set semantics.

        Parameters:
        locationPattern - the location pattern to resolve
        Returns:
        the corresponding Resource objects
        Throws:
        IOException - in case of I/O errors