Class ContainsRegexpSelector
- 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.ContainsRegexpSelector
 
 
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable,- Parameterizable,- ResourceSelector,- ExtendFileSelector,- FileSelector
 
 public class ContainsRegexpSelector extends BaseExtendSelector implements ResourceSelector Selector that filters files based on a regular expression.- Since:
- Ant 1.6
 
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringEXPRESSION_KEYKey to used 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 ContainsRegexpSelector()
 - 
Method SummaryModifier and Type Method Description booleanisSelected(java.io.File basedir, java.lang.String filename, java.io.File file)Tests a regular expression against each line of text in the file.booleanisSelected(Resource r)Tests a regular expression against each line of text in a Resource.voidsetCaseSensitive(boolean b)Whether to ignore case or not.voidsetExpression(java.lang.String theexpression)The regular expression used to search the file.voidsetMultiLine(boolean b)Whether to match should be multiline.voidsetParameters(Parameter... parameters)When using this as a custom selector, this method will be called.voidsetSingleLine(boolean b)Whether to treat input as singleline ('.' matches newline).java.lang.StringtoString()Basic DataType toString().voidverifySettings()Checks that an expression was specified.- 
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
 
- 
 
- 
- 
- 
Field Detail- 
EXPRESSION_KEYpublic static final java.lang.String EXPRESSION_KEY Key to used for parameterized custom selector- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
toStringpublic java.lang.String toString() Description copied from class:DataTypeBasic DataType toString().
 - 
setExpressionpublic void setExpression(java.lang.String theexpression) The regular expression used to search the file.- Parameters:
- theexpression- this must match a line in the file to be selected.
 
 - 
setCaseSensitivepublic void setCaseSensitive(boolean b) Whether to ignore case or not.- Parameters:
- b- if false, ignore case.
- Since:
- Ant 1.8.2
 
 - 
setMultiLinepublic void setMultiLine(boolean b) Whether to match should be multiline.- Parameters:
- b- the value to set.
- Since:
- Ant 1.8.2
 
 - 
setSingleLinepublic void setSingleLine(boolean b) Whether to treat input as singleline ('.' matches newline). Corresponds to java.util.regex.Pattern.DOTALL.- Parameters:
- b- the value to set.
- Since:
- Ant 1.8.2
 
 - 
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 that an expression was specified.- Overrides:
- verifySettingsin class- BaseSelector
 
 - 
isSelectedpublic boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.File file)Tests a regular expression against each line of text in the file.- 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
 
 - 
isSelectedpublic boolean isSelected(Resource r) Tests a regular expression against each line of text in a Resource.- Specified by:
- isSelectedin interface- FileSelector
- Specified by:
- isSelectedin interface- ResourceSelector
- Parameters:
- r- the Resource to check.
- Returns:
- whether the Resource is selected or not
 
 
- 
 
-