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:
java.lang.Cloneable,Parameterizable,ResourceSelector,ExtendFileSelector,FileSelector
public class ContainsSelector extends BaseExtendSelector implements ResourceSelector
Selector that filters files/resources based on whether they contain a particular string.- Since:
- 1.5
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringCASE_KEYUsed for parameterized custom selectorstatic java.lang.StringCONTAINS_KEYUsed for parameterized custom selectorstatic java.lang.StringEXPRESSION_KEYKey to used for parameterized custom selectorstatic java.lang.StringWHITESPACE_KEYUsed for parameterized custom selector-
Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
parameters
-
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Constructor Description ContainsSelector()
-
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.booleanisSelected(Resource r)The heart of the matter.voidsetCasesensitive(boolean casesensitive)Whether to ignore case in the string being searched.voidsetEncoding(java.lang.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.voidsetText(java.lang.String contains)The string to search for within a file.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.BaseExtendSelector
getParameters
-
Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
getError, setError, setError, validate
-
Methods 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, tooManyAttributes
-
Methods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
-
-
-
Field Detail
-
EXPRESSION_KEY
public static final java.lang.String EXPRESSION_KEY
Key to used for parameterized custom selector- See Also:
- Constant Field Values
-
CONTAINS_KEY
public static final java.lang.String CONTAINS_KEY
Used for parameterized custom selector- See Also:
- Constant Field Values
-
CASE_KEY
public static final java.lang.String CASE_KEY
Used for parameterized custom selector- See Also:
- Constant Field Values
-
WHITESPACE_KEY
public static final java.lang.String WHITESPACE_KEY
Used for parameterized custom selector- See Also:
- Constant Field Values
-
-
Method Detail
-
toString
public java.lang.String toString()
Description copied from class:DataTypeBasic DataType toString().
-
setText
public void setText(java.lang.String contains)
The string to search for within a file.- Parameters:
contains- the string that a file must contain to be selected.
-
setEncoding
public void setEncoding(java.lang.String encoding)
The encoding of the resources processed- Parameters:
encoding- encoding of the resources processed- Since:
- Ant 1.9.0
-
setCasesensitive
public void setCasesensitive(boolean casesensitive)
Whether to ignore case in the string being searched.- Parameters:
casesensitive- whether to pay attention to case sensitivity
-
setIgnorewhitespace
public 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
-
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:
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 pattern 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.- 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
-
isSelected
public boolean isSelected(Resource r)
The heart of the matter. This is where the selector gets to decide on the inclusion of a Resource.- Specified by:
isSelectedin interfaceFileSelector- Specified by:
isSelectedin interfaceResourceSelector- Parameters:
r- the Resource to check.- Returns:
- whether the Resource is selected.
-
-