IterableResourceLoader

All Superinterfaces:: AutoCloseable, ResourceLoader

All Known Implementing Classes:: FileResourceLoader, FilteredIterableResourceLoader, JarFileResourceLoader

public interface IterableResourceLoader extends ResourceLoader

A resource loader which has the ability to enumerate its contents.

Method Summary

Modifier and Type

Method

Description

Iterator<Resource>

iterateResources(String startPath, boolean recursive)

Enumerate all the resources under the given path.

Methods inherited from interface ResourceLoader
close, getClassSpec, getLibrary, getLocation, getPackageSpec, getPaths, getResource, getRootName

Method Details
- iterateResources
  
  Iterator<Resource> iterateResources(String startPath, boolean recursive)
  
  Enumerate all the resources under the given path. The given path name is relative to the root of the resource loader. If the path "escapes" the root via .., such segments will be consumed. If the path is absolute, it will be converted to a relative path by dropping the leading /.
  
  Parameters:
  
  startPath - the path to search under
  
  recursive - true to recursively descend into subdirectories, false to only read this path
  
  Returns:
  
  the resource iterator (possibly empty)