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 SummaryFields 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- 
Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelectorparameters
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description FilenameSelector()
 - 
Method SummaryModifier 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.BaseExtendSelectorgetParameters
 - 
Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorgetError, setError, setError, validate
 - 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 - 
Methods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 - 
Methods inherited from interface org.apache.tools.ant.types.selectors.FileSelectorisSelected
 
- 
 
- 
- 
- 
Field Detail- 
NAME_KEYpublic static final java.lang.String NAME_KEY Used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
CASE_KEYpublic static final java.lang.String CASE_KEY Used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
NEGATE_KEYpublic static final java.lang.String NEGATE_KEY Used for parameterized custom selector- See Also:
- Constant Field Values
 
 - 
REGEX_KEYpublic static final java.lang.String REGEX_KEY Used for parameterized custom selector- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
toStringpublic java.lang.String toString() Description copied from class:DataTypeBasic DataType toString().
 - 
setNamepublic 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.
 
 - 
setRegexpublic 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.
 
 - 
setCasesensitivepublic void setCasesensitive(boolean casesensitive) Whether to ignore case when checking filenames.- Parameters:
- casesensitive- whether to pay attention to case sensitivity
 
 - 
setNegatepublic 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
 
 - 
setParameterspublic 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:
- setParametersin interface- Parameterizable
- Overrides:
- setParametersin class- BaseExtendSelector
- Parameters:
- parameters- the complete set of parameters for this selector
 
 - 
verifySettingspublic void verifySettings() Checks to make sure all settings are kosher. In this case, it means that the name attribute has been set.- Overrides:
- verifySettingsin class- BaseSelector
 
 - 
isSelectedpublic 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 interface- FileSelector
- Specified by:
- isSelectedin class- BaseExtendSelector
- Parameters:
- basedir- the base directory the scan is being done from
- filename- is the name of the file to check
- file- is a java.io.File object the selector can use
- Returns:
- whether the file should be selected or not
 
 
- 
 
-