Class ContainsSelector
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.ContainsSelector
- All Implemented Interfaces:
- Cloneable,- Parameterizable,- ResourceSelector,- ExtendFileSelector,- FileSelector
Selector that filters files/resources based on whether they contain a
 particular string.
- Since:
- 1.5
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringUsed for parameterized custom selectorstatic final StringUsed for parameterized custom selectorstatic final StringKey to used for parameterized custom selectorstatic final StringUsed for parameterized custom selectorFields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelectorparametersFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleanisSelected(File basedir, String filename, File file) The heart of the matter.booleanThe heart of the matter.voidsetCasesensitive(boolean casesensitive) Whether to ignore case in the string being searched.voidsetEncoding(String encoding) The encoding of the resources processedvoidsetIgnorewhitespace(boolean ignorewhitespace) Whether to ignore whitespace in the string being searched.voidsetParameters(Parameter... parameters) When using this as a custom selector, this method will be called.voidThe string to search for within a file.toString()Basic DataType toString().voidChecks to make sure all settings are kosher.Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelectorgetParametersMethods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorgetError, setError, setError, validateMethods 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, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
- 
Field Details- 
EXPRESSION_KEY
- 
CONTAINS_KEY
- 
CASE_KEY
- 
WHITESPACE_KEY
 
- 
- 
Constructor Details- 
ContainsSelectorpublic ContainsSelector()
 
- 
- 
Method Details- 
toString
- 
setTextThe string to search for within a file.- Parameters:
- contains- the string that a file must contain to be selected.
 
- 
setEncodingThe encoding of the resources processed- Parameters:
- encoding- encoding of the resources processed
- Since:
- Ant 1.9.0
 
- 
setCasesensitivepublic void setCasesensitive(boolean casesensitive) Whether to ignore case in the string being searched.- Parameters:
- casesensitive- whether to pay attention to case sensitivity
 
- 
setIgnorewhitespacepublic void setIgnorewhitespace(boolean ignorewhitespace) Whether to ignore whitespace in the string being searched.- Parameters:
- ignorewhitespace- whether to ignore any whitespace (spaces, tabs, etc.) in the searchstring
 
- 
setParametersWhen 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 pattern attribute has been set.- Overrides:
- verifySettingsin class- BaseSelector
 
- 
isSelectedThe heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset.- 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
 
- 
isSelectedThe heart of the matter. This is where the selector gets to decide on the inclusion of a Resource.- Specified by:
- isSelectedin interface- FileSelector
- Specified by:
- isSelectedin interface- ResourceSelector
- Parameters:
- r- the Resource to check.
- Returns:
- whether the Resource is selected.
 
 
-