Class ResourceEnumerator


  • public abstract class ResourceEnumerator
    extends java.lang.Object
    Resource enumerator that holds the base path to be used in path relativizations.
    Since:
    8.0.0
    Version:
    $Revision$ $Date$
    • Constructor Summary

      Constructors 
      Constructor Description
      ResourceEnumerator​(java.net.URI basePath)
      Creates a new instance.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      java.net.URI getBasePath()
      Returns the base path to be used in path relativizations.
      abstract java.util.Set<java.lang.String> listResources​(boolean recursively)
      Lists the available resources within the given basePath.
      If the given base path does not exists, an empty set is returned.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ResourceEnumerator

        public ResourceEnumerator​(java.net.URI basePath)
        Creates a new instance.
        Parameters:
        basePath - the base path to be used in path relativizations.
        Since:
        8.0.0
    • Method Detail

      • getBasePath

        public java.net.URI getBasePath()
        Returns the base path to be used in path relativizations.
        Returns:
        the base path to be used in path relativizations.
        Since:
        8.0.0
      • listResources

        public abstract java.util.Set<java.lang.String> listResources​(boolean recursively)
        Lists the available resources within the given basePath.
        If the given base path does not exists, an empty set is returned.
        Parameters:
        recursively - indicates whether the resource search should be recursive.
        Returns:
        the available resources within the given basePath.
        Since:
        8.0.0