org.codehaus.plexus.util
public abstract class AbstractScanner extends Object implements Scanner
Field Summary | |
---|---|
static String[] | DEFAULTEXCLUDES
Patterns which should be excluded by default, like SCM files
|
protected String[] | excludes The patterns for the files to be excluded. |
protected String[] | includes The patterns for the files to be included. |
protected boolean | isCaseSensitive
Whether or not the file system should be treated as a case sensitive
one. |
Method Summary | |
---|---|
void | addDefaultExcludes()
Adds default exclusions to the current exclusions set. |
protected boolean | couldHoldIncluded(String name)
Tests whether or not a name matches the start of at least one include
pattern.
|
protected boolean | isExcluded(String name)
Tests whether or not a name matches against at least one exclude
pattern.
|
protected boolean | isIncluded(String name)
Tests whether or not a name matches against at least one include
pattern.
|
static boolean | match(String pattern, String str)
Tests whether or not a string matches against a pattern.
|
protected static boolean | match(String pattern, String str, boolean isCaseSensitive)
Tests whether or not a string matches against a pattern.
|
protected static boolean | matchPath(String pattern, String str)
Tests whether or not a given path matches a given pattern.
|
protected static boolean | matchPath(String pattern, String str, boolean isCaseSensitive)
Tests whether or not a given path matches a given pattern.
|
protected static boolean | matchPatternStart(String pattern, String str)
Tests whether or not a given path matches the start of a given
pattern up to the first "**".
|
protected static boolean | matchPatternStart(String pattern, String str, boolean isCaseSensitive)
Tests whether or not a given path matches the start of a given
pattern up to the first "**".
|
void | setCaseSensitive(boolean isCaseSensitive)
Sets whether or not the file system should be regarded as case sensitive.
|
void | setExcludes(String[] excludes)
Sets the list of exclude patterns to use. |
void | setIncludes(String[] includes)
Sets the list of include patterns to use. |
protected void | setupDefaultFilters() |
See Also: addDefaultExcludes
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.
Parameters: name The name to match. Must not be null
.
Returns: true
when the name matches against at least one
exclude pattern, or false
otherwise.
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.
Parameters: pattern The pattern to match against.
Must not be null
. str The string which must be matched against the pattern.
Must not be null
.
Returns: true
if the string matches against the pattern,
or false
otherwise.
Parameters: pattern The pattern to match against.
Must not be null
. str The string which must be matched against the pattern.
Must not be null
. isCaseSensitive Whether or not matching should be performed
case sensitively.
Returns: true
if the string matches against the pattern,
or false
otherwise.
Parameters: pattern The pattern to match against. Must not be
null
. str The path to match, as a String. Must not be
null
.
Returns: true
if the pattern matches against the string,
or false
otherwise.
Parameters: pattern The pattern to match against. Must not be
null
. str The path to match, as a String. Must not be
null
. isCaseSensitive Whether or not matching should be performed
case sensitively.
Returns: true
if the pattern matches against the string,
or false
otherwise.
This is not a general purpose test and should only be used if you
can live with false positives. For example, pattern=**\a
and str=b
will yield true
.
Parameters: pattern The pattern to match against. Must not be
null
. str The path to match, as a String. Must not be
null
.
Returns: whether or not a given path matches the start of a given pattern up to the first "**".
This is not a general purpose test and should only be used if you
can live with false positives. For example, pattern=**\a
and str=b
will yield true
.
Parameters: pattern The pattern to match against. Must not be
null
. str The path to match, as a String. Must not be
null
. isCaseSensitive Whether or not matching should be performed
case sensitively.
Returns: whether or not a given path matches the start of a given pattern up to the first "**".
Parameters: isCaseSensitive whether or not the file system should be regarded as a case sensitive one
File.separatorChar
, so the separator used
need not match File.separatorChar
.
When a pattern ends with a '/' or '\', "**" is appended.
Parameters: excludes A list of exclude patterns.
May be null
, indicating that no files
should be excluded. If a non-null
list is
given, all elements must be non-null
.
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
.