Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.types.selectors

Class ContainsRegexpSelector

Implemented Interfaces:
ExtendFileSelector, FileSelector, Parameterizable
public class ContainsRegexpSelector
extends BaseExtendSelector
Selector that filters files based on a regular expression.
Since:
Ant 1.6

Field Summary

static String
EXPRESSION_KEY
Key to used for parameterized custom selector

Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

parameters

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

ContainsRegexpSelector()
Creates a new ContainsRegexpSelector instance.

Method Summary

boolean
isSelected(File basedir, String filename, File file)
Tests a regular expression against each line of text in the file.
void
setExpression(String theexpression)
The regular expression used to search the file.
void
setParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
String
toString()
void
verifySettings()
Checks that an expression was specified.

Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

getParameters, isSelected, setParameters

Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector

getError, isSelected, setError, validate, verifySettings

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

EXPRESSION_KEY

public static final String EXPRESSION_KEY
Key to used for parameterized custom selector

Constructor Details

ContainsRegexpSelector

public ContainsRegexpSelector()
Creates a new ContainsRegexpSelector instance.

Method Details

isSelected

public boolean isSelected(File basedir,
                          String filename,
                          File file)
Tests a regular expression against each line of text in the file.
Specified by:
isSelected in interface FileSelector
Overrides:
isSelected in interface 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

setExpression

public void setExpression(String theexpression)
The regular expression used to search the file.
Parameters:
theexpression - this must match a line in the file to be selected.

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:
setParameters in interface Parameterizable
Overrides:
setParameters in interface BaseExtendSelector
Parameters:
parameters - the complete set of parameters for this selector

toString

public String toString()
Returns:
a string describing this object

verifySettings

public void verifySettings()
Checks that an expression was specified.
Overrides:
verifySettings in interface BaseSelector

Overview Package Tree Index Deprecated About
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.