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:
java.lang.Cloneable,Parameterizable,ResourceSelector,ExtendFileSelector,FileSelector
public class FilenameSelector extends BaseExtendSelector
Selector that filters files based on the filename.
- Since:
- 1.5
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCASE_KEYUsed for parameterized custom selectorstatic java.lang.StringNAME_KEYUsed for parameterized custom selectorstatic java.lang.StringNEGATE_KEYUsed for parameterized custom selectorstatic java.lang.StringREGEX_KEYUsed for parameterized custom selector -
Constructor Summary
Constructors Constructor Description FilenameSelector() -
Method Summary
Modifier and Type Method Description booleanisSelected(java.io.File basedir, java.lang.String filename, java.io.File file)The heart of the matter.voidsetCasesensitive(boolean casesensitive)Whether to ignore case when checking filenames.voidsetName(java.lang.String pattern)The name of the file, or the pattern for the name, that should be used for selection.voidsetNegate(boolean negated)You can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true.voidsetParameters(Parameter... parameters)When using this as a custom selector, this method will be called.voidsetRegex(java.lang.String pattern)The regular expression the file name will be matched against.java.lang.StringtoString()Basic DataType toString().voidverifySettings()Checks to make sure all settings are kosher.Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
getError, setError, setError, validateMethods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Field Details
-
NAME_KEY
public static final java.lang.String NAME_KEYUsed for parameterized custom selector- See Also:
- Constant Field Values
-
CASE_KEY
public static final java.lang.String CASE_KEYUsed for parameterized custom selector- See Also:
- Constant Field Values
-
NEGATE_KEY
public static final java.lang.String NEGATE_KEYUsed for parameterized custom selector- See Also:
- Constant Field Values
-
REGEX_KEY
public static final java.lang.String REGEX_KEYUsed for parameterized custom selector- See Also:
- Constant Field Values
-
-
Constructor Details
-
FilenameSelector
public FilenameSelector()
-
-
Method Details
-
toString
public java.lang.String toString()Description copied from class:DataTypeBasic DataType 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.
-
setRegex
public void setRegex(java.lang.String pattern)The regular expression the file name will be matched against.- Parameters:
pattern- the regular expression 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
When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.- Specified by:
setParametersin interfaceParameterizable- Overrides:
setParametersin classBaseExtendSelector- 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:
verifySettingsin classBaseSelector
-
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:
isSelectedin interfaceFileSelector- Specified by:
isSelectedin classBaseExtendSelector- 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
-