org.apache.tools.ant.types.selectors

Class BaseSelector

public abstract class BaseSelector extends DataType implements FileSelector

A convenience base class that you can subclass Selectors from. It provides some helpful common behaviour. Note that there is no need for Selectors to inherit from this class, it is only necessary that they implement FileSelector.

Since: 1.5

Constructor Summary
BaseSelector()
Do nothing constructor.
Method Summary
StringgetError()
Returns any error messages that have been set.
abstract booleanisSelected(File basedir, String filename, File file)
Method that each selector will implement to create their selection behaviour.
voidsetError(String msg)
Allows all selectors to indicate a setup error.
voidvalidate()
Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.
voidverifySettings()

Subclasses can override this method to provide checking of their state.

Constructor Detail

BaseSelector

public BaseSelector()
Do nothing constructor.

Method Detail

getError

public String getError()
Returns any error messages that have been set.

Returns: the error condition

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

setError

public void setError(String msg)
Allows all selectors to indicate a setup error. Note that only the first error message is recorded.

Parameters: msg The error message any BuildException should throw.

validate

public void validate()
Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.

verifySettings

public void verifySettings()

Subclasses can override this method to provide checking of their state. So long as they call validate() from isSelected(), this will be called automatically (unless they override validate()).

Implementations should check for incorrect settings and call setError() as necessary.