|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.components.io.fileselectors.IncludeExcludeFileSelector
public class IncludeExcludeFileSelector
This file selector uses a set of patterns for including/excluding files.
Field Summary | |
---|---|
static java.lang.String |
ROLE_HINT
The include/exclude file selectors role-hint: "standard". |
Fields inherited from interface org.codehaus.plexus.components.io.fileselectors.FileSelector |
---|
DEFAULT_ROLE_HINT, ROLE |
Constructor Summary | |
---|---|
IncludeExcludeFileSelector()
|
Method Summary | |
---|---|
java.lang.String[] |
getExcludes()
Returns the list of exclude patterns to use. |
java.lang.String[] |
getIncludes()
Returns the list of include patterns to use. |
boolean |
isCaseSensitive()
Returns, whether the include/exclude patterns are case sensitive. |
protected boolean |
isExcluded(java.lang.String name)
Tests whether or not a name matches against at least one exclude pattern. |
protected boolean |
isIncluded(java.lang.String name)
Tests whether or not a name matches against at least one include pattern. |
boolean |
isSelected(FileInfo pFileInfo)
Returns, whether the given file is selected. |
boolean |
isUseDefaultExcludes()
Returns, whether to use the default excludes, as specified by FileUtils.getDefaultExcludes() . |
protected boolean |
matchPath(java.lang.String pattern,
java.lang.String name,
boolean isCaseSensitive)
Tests, whether the given pattern is matching the given name. |
void |
setCaseSensitive(boolean caseSensitive)
Sets, whether the include/exclude patterns are case sensitive. |
void |
setExcludes(java.lang.String[] excludes)
Sets the list of exclude patterns to use. |
void |
setIncludes(java.lang.String[] includes)
Sets the list of include patterns to use. |
void |
setUseDefaultExcludes(boolean pUseDefaultExcludes)
Sets, whether to use the default excludes, as specified by FileUtils.getDefaultExcludes() . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ROLE_HINT
Constructor Detail |
---|
public IncludeExcludeFileSelector()
Method Detail |
---|
protected boolean isExcluded(java.lang.String name)
name
- The name to match. Must not be null
.
true
when the name matches against at least one
exclude pattern, or false
otherwise.public void setIncludes(java.lang.String[] includes)
File.separatorChar
, so the separator used
need not match File.separatorChar
.
When a pattern ends with a '/' or '\', "**" is appended.
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
.public java.lang.String[] getIncludes()
null
, indicating that all files
should be included. If a non-null
list is given, all elements must be
non-null
.public void setExcludes(java.lang.String[] excludes)
File.separatorChar
, so the separator used
need not match File.separatorChar
.
When a pattern ends with a '/' or '\', "**" is appended.
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
.public java.lang.String[] getExcludes()
null
, indicating that no files
should be excluded. If a non-null
list is
given, all elements must be non-null
.protected boolean matchPath(java.lang.String pattern, java.lang.String name, boolean isCaseSensitive)
pattern
- The pattern to matchname
- The name to testisCaseSensitive
- Whether the pattern is case sensitive.
protected boolean isIncluded(java.lang.String name)
name
- The name to match. Must not be null
.
true
when the name matches against at least one
include pattern, or false
otherwise.public boolean isSelected(FileInfo pFileInfo) throws java.io.IOException
FileSelector
isSelected
in interface FileSelector
java.io.IOException
public boolean isCaseSensitive()
public void setCaseSensitive(boolean caseSensitive)
caseSensitive
- True, if the patterns are case sensitive (default), or false.public boolean isUseDefaultExcludes()
FileUtils.getDefaultExcludes()
.
public void setUseDefaultExcludes(boolean pUseDefaultExcludes)
FileUtils.getDefaultExcludes()
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |