org.apache.tools.ant.types.selectors
Class BaseSelector
- Cloneable, FileSelector
public abstract class BaseSelector
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.
String | getError() - Returns any error messages that have been set.
|
abstract boolean | isSelected(File basedir, String filename, File file) - Method that each selector will implement to create their
selection behaviour.
|
void | setError(String msg) - Allows all selectors to indicate a setup error.
|
void | validate() - Subclasses can use this to throw the requisite exception
in isSelected() in the case of an error condition.
|
void | verifySettings() - Subclasses can override this method to provide checking of their
state.
|
checkAttributesAllowed , checkChildrenAllowed , circularReference , clone , dieOnCircularReference , dieOnCircularReference , dieOnCircularReference , getCheckedRef , getCheckedRef , getCheckedRef , getCheckedRef , getDataTypeName , getRefid , invokeCircularReferenceCheck , isChecked , isReference , noChildrenAllowed , setChecked , setRefid , toString , tooManyAttributes |
BaseSelector
public BaseSelector()
Do nothing constructor.
getError
public String getError()
Returns any error messages that have been set.
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.
- isSelected in interface FileSelector
basedir
- A java.io.File object for the base directoryfilename
- The name of the file to checkfile
- A File object for this filename
- 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.
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.