org.apache.tools.ant.types.selectors

Class BaseExtendSelector

public abstract class BaseExtendSelector extends BaseSelector implements ExtendFileSelector

Convenience base class for all selectors accessed through ExtendSelector. It provides support for gathering the parameters together as well as for assigning an error message and throwing a build exception if an error is detected.

Since: 1.5

Field Summary
protected Parameter[]parameters
The passed in parameter array.
Constructor Summary
BaseExtendSelector()
Default constructor.
Method Summary
protected Parameter[]getParameters()
Allows access to the parameters gathered and set within the <custom> tag.
abstract booleanisSelected(File basedir, String filename, File file)
Method that each selector will implement to create their selection behaviour.
voidsetParameters(Parameter[] parameters)
Set all the Parameters for this custom selector, collected by the ExtendSelector class.

Field Detail

parameters

protected Parameter[] parameters
The passed in parameter array.

Constructor Detail

BaseExtendSelector

public BaseExtendSelector()
Default constructor.

Method Detail

getParameters

protected Parameter[] getParameters()
Allows access to the parameters gathered and set within the <custom> tag.

Returns: the set of parameters defined for this selector

isSelected

public abstract boolean isSelected(File basedir, String filename, File file)
Method that each selector will implement to create their selection behaviour. If there is a problem with the setup of a selector, it can throw a BuildException to indicate the problem.

Parameters: basedir A java.io.File object for the base directory filename The name of the file to check file A File object for this filename

Returns: whether the file should be selected or not

Throws: BuildException if an error occurs

setParameters

public void setParameters(Parameter[] parameters)
Set all the Parameters for this custom selector, collected by the ExtendSelector class.

Parameters: parameters the complete set of parameters for this selector

Copyright