org.apache.tools.ant.types.selectors
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: 
- ExtendFileSelector, FileSelector, Parameterizable
- Direct Known Subclasses: 
- ContainsRegexpSelector, ContainsSelector, DateSelector, DepthSelector, FilenameSelector, ModifiedSelector, SizeSelector, TypeSelector
- 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
 
 
 
 
| Method Summary | 
| protected  Parameter[] | getParameters()Allows access to the parameters gathered and set within the
 <custom> tag.
 | 
| abstract  boolean | isSelected(java.io.File basedir,
           java.lang.String filename,
           java.io.File file)Method that each selector will implement to create their
 selection behaviour.
 | 
|  void | setParameters(Parameter[] parameters)Set all the Parameters for this custom selector, collected by
 the ExtendSelector class.
 | 
 
 
| Methods inherited from class org.apache.tools.ant.types.DataType | 
| checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes | 
 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
parameters
protected Parameter[] parameters
- The passed in parameter array.
 
 
BaseExtendSelector
public BaseExtendSelector()
- Default constructor.
 
setParameters
public void setParameters(Parameter[] parameters)
- Set all the Parameters for this custom selector, collected by
 the ExtendSelector class.
 
- 
- Specified by:
- setParametersin interface- Parameterizable
 
- 
- Parameters:
- parameters- the complete set of parameters for this selector
 
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(java.io.File basedir,
                                   java.lang.String filename,
                                   java.io.File file)
                            throws BuildException
- 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 interface- FileSelector
- Specified by:
- isSelectedin class- BaseSelector
 
- 
- 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
 
Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.