public class IncludeExcludeFileSelector extends Object implements FileSelector
Modifier and Type | Field and Description |
---|---|
static String |
ROLE_HINT
The include/exclude file selectors role-hint: "standard".
|
DEFAULT_ROLE_HINT, ROLE
Constructor and Description |
---|
IncludeExcludeFileSelector() |
Modifier and Type | Method and Description |
---|---|
String[] |
getExcludes()
Returns the list of exclude patterns to use.
|
String[] |
getIncludes()
Returns the list of include patterns to use.
|
boolean |
isCaseSensitive()
Returns, whether the include/exclude patterns are case sensitive.
|
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.
|
boolean |
isSelected(FileInfo fileInfo)
Returns, whether the given file is selected.
|
boolean |
isUseDefaultExcludes()
Returns, whether to use the default excludes, as specified by
FileUtils.getDefaultExcludes() . |
protected boolean |
matchPath(String pattern,
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(String[] excludes)
Sets the list of exclude patterns to use.
|
void |
setIncludes(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() . |
public static final String ROLE_HINT
protected boolean isExcluded(@Nonnull 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(@Nullable 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
.@Nullable public 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(@Nullable 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
.@Nullable public 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(@Nonnull String pattern, @Nonnull String name, boolean isCaseSensitive)
pattern
- The pattern to matchname
- The name to testisCaseSensitive
- Whether the pattern is case sensitive.protected boolean isIncluded(@Nonnull 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(@Nonnull FileInfo fileInfo)
FileSelector
isSelected
in interface FileSelector
fileInfo
- An instance of FileInfo with the files meta data.
It is recommended, that the caller creates an instance
of PlexusIoResource
.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()
.Copyright © 2001–2019 Codehaus Plexus. All rights reserved.