org.apache.tools.ant.types.selectors
Class FilenameSelector
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.selectors.BaseSelector
org.apache.tools.ant.types.selectors.BaseExtendSelector
org.apache.tools.ant.types.selectors.FilenameSelector
- All Implemented Interfaces:
- ExtendFileSelector, FileSelector, Parameterizable
- public class FilenameSelector
- extends BaseExtendSelector
Selector that filters files based on the filename.
- Since:
- 1.5
- Author:
- Bruce Atherton
Method Summary |
boolean |
isSelected(java.io.File basedir,
java.lang.String filename,
java.io.File file)
The heart of the matter. |
void |
setCasesensitive(boolean casesensitive)
Whether to ignore case when checking filenames. |
void |
setName(java.lang.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. |
java.lang.String |
toString()
|
void |
verifySettings()
Checks to make sure all settings are kosher. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
NAME_KEY
public static final java.lang.String NAME_KEY
- See Also:
- Constant Field Values
CASE_KEY
public static final java.lang.String CASE_KEY
- See Also:
- Constant Field Values
NEGATE_KEY
public static final java.lang.String NEGATE_KEY
- See Also:
- Constant Field Values
FilenameSelector
public FilenameSelector()
toString
public java.lang.String toString()
setName
public void setName(java.lang.String pattern)
- The name of the file, or the pattern for the name, that
should be used for selection.
- Parameters:
pattern
- the file pattern that any filename must match
against in order to be selected.
setCasesensitive
public void setCasesensitive(boolean casesensitive)
- Whether to ignore case when checking filenames.
- Parameters:
casesensitive
- whether to pay attention to case sensitivity
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>.
- Parameters:
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.
- Specified by:
setParameters
in interface Parameterizable
- Overrides:
setParameters
in class BaseExtendSelector
- Parameters:
parameters
- the complete set of parameters for this selector
verifySettings
public void verifySettings()
- Checks to make sure all settings are kosher. In this case, it
means that the name attribute has been set.
- Overrides:
verifySettings
in class BaseSelector
isSelected
public boolean isSelected(java.io.File basedir,
java.lang.String filename,
java.io.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.
- Specified by:
isSelected
in interface FileSelector
- Specified by:
isSelected
in class BaseExtendSelector
- Parameters:
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
- Returns:
- whether the file should be selected or not
Copyright © 2000-2003 Apache Software Foundation. All Rights Reserved.