Class PathScanningMatcher

java.lang.Object
org.apache.sshd.common.util.io.PathScanningMatcher
Direct Known Subclasses:
DirectoryScanner, SftpClientDirectoryScanner

public abstract class PathScanningMatcher extends Object
  • Field Details

    • caseSensitive

      protected boolean caseSensitive
      Whether or not the file system should be treated as a case sensitive one.
    • separator

      protected String separator
      The file separator to use to parse paths - default=local O/S separator
    • includePatterns

      protected List<String> includePatterns
      The patterns for the files to be included.
  • Constructor Details

    • PathScanningMatcher

      protected PathScanningMatcher()
  • Method Details

    • setIncludes

      public void setIncludes(String... includes)

      Sets the list of include patterns to use. All '/' and '\' characters are replaced by File.separatorChar, so the separator used need not match File.separatorChar.

      When a pattern ends with a '/' or '\', "**" is appended.

      Parameters:
      includes - A list of include patterns. May be null, indicating that all files should be included. If a non-null list is given, all elements must be non-null.
    • getIncludes

      public List<String> getIncludes()
      Returns:
      Un-modifiable list of the inclusion patterns
    • setIncludes

      public void setIncludes(Collection<String> includes)
    • isCaseSensitive

      public boolean isCaseSensitive()
      Returns:
      Whether or not the file system should be treated as a case sensitive one.
    • setCaseSensitive

      public void setCaseSensitive(boolean caseSensitive)
    • getSeparator

      public String getSeparator()
      Returns:
      The file separator to use to parse paths - default=local O/S separator
    • setSeparator

      public void setSeparator(String separator)
    • isIncluded

      protected boolean isIncluded(String name)
      Tests whether or not a name matches against at least one include pattern.
      Parameters:
      name - The name to match. Must not be null.
      Returns:
      true when the name matches against at least one include pattern, or false otherwise.
    • couldHoldIncluded

      protected boolean couldHoldIncluded(String name)
      Tests whether or not a name matches the start of at least one include pattern.
      Parameters:
      name - The name to match. Must not be null.
      Returns:
      true when the name matches against the start of at least one include pattern, or false otherwise.
    • normalizePattern

      public static String normalizePattern(String pattern)
      Normalizes the pattern, e.g. converts forward and backward slashes to the platform-specific file separator.
      Parameters:
      pattern - The pattern to normalize, must not be null.
      Returns:
      The normalized pattern, never null.