Class BaseSelector
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.selectors.BaseSelector
- All Implemented Interfaces:
- Cloneable,- ResourceSelector,- FileSelector
- Direct Known Subclasses:
- BaseExtendSelector,- BaseSelectorContainer,- ExtendSelector,- MappingSelector,- PresentSelector,- ScriptSelector
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
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptiongetError()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.voidAllows all selectors to indicate a setup error.voidAllows 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.voidSubclasses can override this method to provide checking of their state.Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toStringMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tools.ant.types.selectors.FileSelectorisSelected
- 
Constructor Details- 
BaseSelectorpublic BaseSelector()
 
- 
- 
Method Details- 
setErrorAllows 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.
 
- 
setErrorAllows 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.
- cause- Throwable
 
- 
getErrorReturns any error messages that have been set.- Returns:
- the error condition
 
- 
verifySettingspublic 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. 
- 
validatepublic void validate()Subclasses can use this to throw the requisite exception in isSelected() in the case of an error condition.
- 
isSelectedMethod 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.- Specified by:
- isSelectedin interface- FileSelector
- 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
 
 
-