Package com.pnfsoftware.jeb.util.io

Class DirectoryEnumerator

java.lang.Object
com.pnfsoftware.jeb.util.io.DirectoryEnumerator
All Implemented Interfaces:
Iterable<File>
public class DirectoryEnumerator extends Object implements Iterable<File>
List (full in-memory enumeration) or iterate over a directory contents, with support for recursion and regex file filters. The returned File Objects are real Files passing the File.isFile() test.

  • Constructor Details

    • DirectoryEnumerator

      public DirectoryEnumerator(File base, String filterString, boolean recurse)
      Create a new directory enumerator.
      Parameters:
      base - base folder
      filterString - optional wildcard filter string for filenames; to use a full regex pattern, provide null for this parameter and use setFilter(Pattern) after construction
      recurse - true to recursively enumerate sub-directories.
      Throws:
      IllegalArgumentException - on initialization error

    • DirectoryEnumerator

      public DirectoryEnumerator(File base)
      Create a new directory enumerator. The enumerator is filter-less (it matches on all files) and does not recurse over sub-directories.
      Parameters:
      base - base folder

  • Method Details

    • setFilterString

      public void setFilterString(String filterString, boolean matchCaseInsensitive, boolean matchUnicode)
      Set a wildcard filename filter.
      Parameters:
      filterString - non-null filter string; to disable filters, use setFilter(Pattern)
      matchCaseInsensitive - true to match case-insensitively
      matchUnicode - true to enable Unicode character classes

    • setFilter

      public void setFilter(Pattern pattern)
      Set a regex pattern to select files.

      Example: ".*\\.(exe|dll)$" will match all Windows executables and dynamic libraries.

      Parameters:
      pattern - optional regex pattern, null to disable

    • getFilter

      public Pattern getFilter()
      Get the active regex filter.
      Returns:
      regex pattern, or null if no filter is active

    • setRecurse

      public void setRecurse(boolean recurse)
      Enable or disable recursive enumeration.
      Parameters:
      recurse - true to recurse into subdirectories

    • isRecurse

      public boolean isRecurse()
      Determine whether recursive enumeration is enabled.
      Returns:
      true if subdirectories are recursively explored

    • addBlackListedDirectory

      public void addBlackListedDirectory(String dirname)
      Record a simple directory name (not path) that should not be recursively explored. Ignored if the enumerator is not recursive. The base directory is always explored, even if its simple name is blacklisted.

      Example: 'xyz' is blacklisted, the search is recursive and starts in '/xyz':
      - "/xyz/..." is explored, no matter what
      - if it exists, "/xyz/xyz/..." and its sub-dirs WONT be explored
      - if it exists, "/xyz/0/1/xyz/..." and its sub-dirs WONT be explored
      - if it exists, file named '/xyz/xyz' or /xyz/foo/xyz" WILL be returned.

      Parameters:
      dirname - simple directory name to skip during recursion

    • getBlacklistedDirnames

      public Collection<String> getBlacklistedDirnames()
      Get the directory names skipped during recursive enumeration.
      Returns:
      unmodifiable collection of blacklisted simple directory names

    • list

      public List<File> list()
      Browse the folder(s) and retrieve the matching files.
      Returns:
      a list of files

    • iterator

      public Iterator<File> iterator()
      Specified by:
      iterator in interface Iterable<File>