org.apache.tools.ant.types.selectors
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:

ExtendFileSelector, FileSelector, Parameterizable

public class ContainsRegexpSelector

extends BaseExtendSelector

Selector that filters files based on a regular expression.

Since:

Ant 1.6

Field Summary

static java.lang.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(java.io.File basedir, java.lang.String filename, java.io.File file) Tests a regular expression against each line of text in the file.
void	setExpression(java.lang.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.
java.lang.String	toString()
void	verifySettings() Checks that an expression was specified.

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, validate

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EXPRESSION_KEY

public static final java.lang.String EXPRESSION_KEY

Key to used for parameterized custom selector

See Also:

Constant Field Values

Constructor Detail

ContainsRegexpSelector

public ContainsRegexpSelector()

Creates a new ContainsRegexpSelector instance.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a string describing this object

setExpression

public 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.

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 class BaseExtendSelector

Parameters:

parameters - the complete set of parameters for this selector

verifySettings

public void verifySettings()

Checks that an expression was specified.

Overrides:

verifySettings in class BaseSelector

isSelected

public 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:

isSelected in interface FileSelector

Specified by:

isSelected in 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