Class BaseExtendSelector
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
- All Implemented Interfaces:
Cloneable,Parameterizable,ResourceSelector,ExtendFileSelector,FileSelector
- Direct Known Subclasses:
ContainsRegexpSelector,ContainsSelector,DateSelector,DepthSelector,FilenameSelector,ModifiedSelector,SizeSelector,TypeSelector
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
FieldsFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected Parameter[]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.Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
getError, setError, setError, validate, verifySettingsMethods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, 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.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tools.ant.types.selectors.FileSelector
isSelected
-
Field Details
-
parameters
The passed in parameter array.
-
-
Constructor Details
-
BaseExtendSelector
public BaseExtendSelector()
-
-
Method Details
-
setParameters
Set all the Parameters for this custom selector, collected by the ExtendSelector class.- Specified by:
setParametersin interfaceParameterizable- Parameters:
parameters- the complete set of parameters for this selector
-
getParameters
Allows access to the parameters gathered and set within the <custom> tag.- Returns:
- the set of parameters defined for this selector
-
isSelected
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.- Specified by:
isSelectedin interfaceFileSelector- Specified by:
isSelectedin classBaseSelector- Parameters:
basedir- A java.io.File object for the base directoryfilename- The name of the file to checkfile- A File object for this filename- Returns:
- whether the file should be selected or not
- Throws:
BuildException- if an error occurs
-