Class RecursiveFileSearch

java.lang.Object
edu.umd.cs.findbugs.RecursiveFileSearch
public class RecursiveFileSearch extends Object
Recursively search a directory, its subdirectories, etc. Note that the search algorithm uses a worklist, so its implementation does not use recursive method calls.

  • Field Details

    • baseDir

      private final String baseDir

    • fileFilter

      private final FileFilter fileFilter

    • directoryWorkList

      private final LinkedList<File> directoryWorkList

    • directoriesScanned

      private final HashSet<String> directoriesScanned

    • directoriesScannedList

      private final List<String> directoriesScannedList

    • resultList

      private final ArrayList<String> resultList

  • Constructor Details

    • RecursiveFileSearch

      public RecursiveFileSearch(String baseDir, FileFilter fileFilter)
      Constructor.
      Parameters:
      baseDir - the base directory for the search
      fileFilter - chooses files to add to the results, and subdirectories to continue the search in

  • Method Details

    • bestEffortCanonicalPath

      static String bestEffortCanonicalPath(File f)

    • search

      public RecursiveFileSearch search() throws InterruptedException
      Perform the search.
      Returns:
      this object
      Throws:
      InterruptedException - if the thread is interrupted before the search completes

    • fileNameIterator

      public Iterator<String> fileNameIterator()
      Get an iterator over the files found by the search. The full path names of the files are returned.

    • getDirectoriesScanned

      public List<String> getDirectoriesScanned()