Class PatternFileSelector

java.lang.Object
org.apache.commons.vfs2.PatternFileSelector
All Implemented Interfaces:
FileSelector

public class PatternFileSelector extends Object implements FileSelector
A FileSelector that selects based on regular expressions.

The regular expression specified in one of the constructors is matched against FileName.getPath() of all candidate files. If you want to match only against the base file name, make sure to prefix the pattern with ".*\\/".

Since:
2.1
  • Field Details

    • pattern

      private final Pattern pattern
      The extensions to select.
  • Constructor Details

    • PatternFileSelector

      public PatternFileSelector(Pattern pattern)
      Creates a new selector for the given pattern.

      See PatternFileSelector for a specification how the pattern is matched.

      Parameters:
      pattern - The regular expressed used by this selector.
    • PatternFileSelector

      public PatternFileSelector(String regex)
      Creates a new selector for the given pattern.

      See PatternFileSelector for a specification how the pattern is matched.

      Parameters:
      regex - The regular expressed used by this selector.
      See Also:
    • PatternFileSelector

      public PatternFileSelector(String regex, int flags)
      Creates a new selector for the given Pattern and flags.

      See PatternFileSelector for a specification how the pattern is matched.

      Parameters:
      regex - The expression to be compiled
      flags - Match flags, a bit mask.
      See Also:
  • Method Details

    • includeFile

      public boolean includeFile(FileSelectInfo fileInfo) throws Exception
      Determines if a file or folder should be selected.

      See PatternFileSelector for a specification how the pattern is matched.

      Specified by:
      includeFile in interface FileSelector
      Parameters:
      fileInfo - The file selection information.
      Returns:
      true if the file should be selected, false otherwise.
      Throws:
      Exception - if an error occurs.
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • traverseDescendents

      public boolean traverseDescendents(FileSelectInfo fileInfo) throws Exception
      Determines whether a folder should be traversed.

      This implementation always returns true to make sure all leafs are inspected.

      Specified by:
      traverseDescendents in interface FileSelector
      Parameters:
      fileInfo - The file selection information.
      Returns:
      true if descendants should be traversed, false otherwise.
      Throws:
      Exception - if an error occurs.