org.apache.tools.ant.types.selectors
Class FilenameSelector
- ExtendFileSelector, FileSelector, Parameterizable
public class FilenameSelector
Selector that filters files based on the filename.
static String | CASE_KEY - Used for parameterized custom selector
|
static String | NAME_KEY - Used for parameterized custom selector
|
static String | NEGATE_KEY - Used for parameterized custom selector
|
boolean | isSelected(File basedir, String filename, File file) - The heart of the matter.
|
void | setCasesensitive(boolean casesensitive) - Whether to ignore case when checking filenames.
|
void | setName(String pattern) - The name of the file, or the pattern for the name, that
should be used for selection.
|
void | setNegate(boolean negated) - You can optionally reverse the selection of this selector,
thereby emulating an <exclude> tag, by setting the attribute
negate to true.
|
void | setParameters(Parameter[] parameters) - When using this as a custom selector, this method will be called.
|
String | toString()
|
void | verifySettings() - Checks to make sure all settings are kosher.
|
checkAttributesAllowed , checkChildrenAllowed , circularReference , dieOnCircularReference , getCheckedRef , getDescription , getRefid , isChecked , isReference , noChildrenAllowed , setChecked , setDescription , setRefid , tooManyAttributes |
CASE_KEY
public static final String CASE_KEY
Used for parameterized custom selector
NAME_KEY
public static final String NAME_KEY
Used for parameterized custom selector
NEGATE_KEY
public static final String NEGATE_KEY
Used for parameterized custom selector
FilenameSelector
public FilenameSelector()
Creates a new FilenameSelector
instance.
isSelected
public boolean isSelected(File basedir,
String filename,
File file)
The heart of the matter. This is where the selector gets to decide
on the inclusion of a file in a particular fileset. Most of the work
for this selector is offloaded into SelectorUtils, a static class
that provides the same services for both FilenameSelector and
DirectoryScanner.
- isSelected in interface FileSelector
- isSelected in interface BaseExtendSelector
basedir
- the base directory the scan is being done fromfilename
- is the name of the file to checkfile
- is a java.io.File object the selector can use
- whether the file should be selected or not
setCasesensitive
public void setCasesensitive(boolean casesensitive)
Whether to ignore case when checking filenames.
casesensitive
- whether to pay attention to case sensitivity
setName
public void setName(String pattern)
The name of the file, or the pattern for the name, that
should be used for selection.
pattern
- the file pattern that any filename must match
against in order to be selected.
setNegate
public void setNegate(boolean negated)
You can optionally reverse the selection of this selector,
thereby emulating an <exclude> tag, by setting the attribute
negate to true. This is identical to surrounding the selector
with <not></not>.
negated
- whether to negate this selection
setParameters
public void setParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
It translates each parameter into the appropriate setXXX() call.
- setParameters in interface Parameterizable
- setParameters in interface BaseExtendSelector
parameters
- the complete set of parameters for this selector
toString
public String toString()
- a string describing this object
verifySettings
public void verifySettings()
Checks to make sure all settings are kosher. In this case, it
means that the name attribute has been set.
- verifySettings in interface BaseSelector
Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.