Apache Mina SSHD 2.15.0 · org.apache.sshd.common.util.io.PathScanningMatcher

Modifier and Type	Field and Description
protected boolean	caseSensitive Whether or not the file system should be treated as a case sensitive one.
protected List<String>	includePatterns The patterns for the files to be included.
protected String	separator The file separator to use to parse paths - default=local O/S separator

Access	Constructor and Description
protected	PathScanningMatcher()

Method Summary

Modifier and Type	Method and Description
protected boolean	Returns: `true` when the name matches against the start of at least one include pattern, or `false` otherwise. couldHoldIncluded(String The name to match. Must not be `null`. name) Tests whether or not a name matches the start of at least one include pattern.
public List<String>	Returns: Un-modifiable list of the inclusion patterns getIncludes()
public String	Returns: The file separator to use to parse paths - default=local O/S separator getSeparator()
public boolean	Returns: Whether or not the file system should be treated as a case sensitive one. isCaseSensitive()
protected boolean	Returns: `true` when the name matches against at least one include pattern, or `false` otherwise. isIncluded(String The name to match. Must not be `null`. name) Tests whether or not a name matches against at least one include pattern.
public static String	Returns: The normalized pattern, never `null`. normalizePattern(String The pattern to normalize, must not be `null`. pattern) Normalizes the pattern, e.g. converts forward and backward slashes to the platform-specific file separator.
public void	setCaseSensitive(boolean caseSensitive)
public void	setIncludes(String... 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`. includes) Sets the list of include patterns to use.
public void	setIncludes(Collection<String> includes)
public void	setSeparator(String separator)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

caseSensitive	back to summary
protected boolean caseSensitive Whether or not the file system should be treated as a case sensitive one.

includePatterns	back to summary
protected List<String> includePatterns The patterns for the files to be included.

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

PathScanningMatcher	back to summary
protected PathScanningMatcher()

Method Detail

couldHoldIncluded back to summary

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

protected boolean couldHoldIncluded(String name)

Tests whether or not a name matches the start of at least one include pattern.

Parameters

name:String: The name to match. Must not be null.

Returns:boolean

true when the name matches against the start of at least one include pattern, or false otherwise.

getIncludes	back to summary
public List<String> getIncludes() Returns:List<String> Un-modifiable list of the inclusion patterns

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

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

isIncluded back to summary

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

protected boolean isIncluded(String name)

Tests whether or not a name matches against at least one include pattern.

Parameters

name:String: The name to match. Must not be null.

Returns:boolean

true when the name matches against at least one include pattern, or false otherwise.

normalizePattern back to summary

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

public static String normalizePattern(String pattern)

Normalizes the pattern, e.g. converts forward and backward slashes to the platform-specific file separator.

Parameters

pattern:String: The pattern to normalize, must not be null.

Returns:String

The normalized pattern, never null.

setCaseSensitive	back to summary
public void setCaseSensitive(boolean caseSensitive)

setIncludes back to summary

setIncludes	back to summary
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:String[] 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`.

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:String[]: 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.

setIncludes	back to summary
public void setIncludes(Collection<String> includes)

setSeparator	back to summary
public void setSeparator(String separator)

public abstract Class PathScanningMatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail