Class DepthSelector
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
org.apache.tools.ant.types.selectors.DepthSelector
- All Implemented Interfaces:
- Cloneable,- Parameterizable,- ResourceSelector,- ExtendFileSelector,- FileSelector
Selector that filters files based on the how deep in the directory
 tree they are.
- Since:
- 1.5
- 
Field SummaryFieldsModifier and TypeFieldDescriptionintmax attributestatic final StringUsed for parameterized custom selectorintmin attributestatic final StringUsed for parameterized custom selectorFields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelectorparametersFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionbooleanisSelected(File basedir, String filename, File file) The heart of the matter.voidsetMax(int max) The minimum depth below the basedir before a file is selected.voidsetMin(int min) The minimum depth below the basedir before a file is selected.voidsetParameters(Parameter... parameters) When using this as a custom selector, this method will be called.toString()Basic DataType toString().voidChecks to make sure all settings are kosher.Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelectorgetParametersMethods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorgetError, setError, setError, validateMethods 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, tooManyAttributesMethods 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
- 
Field Details- 
MIN_KEYUsed for parameterized custom selector- See Also:
 
- 
MAX_KEYUsed for parameterized custom selector- See Also:
 
- 
minpublic int minmin attribute
- 
maxpublic int maxmax attribute
 
- 
- 
Constructor Details- 
DepthSelectorpublic DepthSelector()
 
- 
- 
Method Details- 
toStringDescription copied from class:DataTypeBasic DataType toString().
- 
setMinpublic void setMin(int min) The minimum depth below the basedir before a file is selected.- Parameters:
- min- minimum directory levels below basedir to go
 
- 
setMaxpublic void setMax(int max) The minimum depth below the basedir before a file is selected.- Parameters:
- max- maximum directory levels below basedir to go
 
- 
setParametersWhen using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.- Specified by:
- setParametersin interface- Parameterizable
- Overrides:
- setParametersin class- BaseExtendSelector
- Parameters:
- parameters- the complete set of parameters for this selector
 
- 
verifySettingspublic void verifySettings()Checks to make sure all settings are kosher. In this case, it means that the max depth is not lower than the min depth.- Overrides:
- verifySettingsin class- BaseSelector
 
- 
isSelectedThe heart of the matter. This is where the selector gets to decide on the inclusion of a file in a particular fileset. Most of the work for this selector is offloaded into SelectorUtils, a static class that provides the same services for both FilenameSelector and DirectoryScanner.- Specified by:
- isSelectedin interface- FileSelector
- Specified by:
- isSelectedin class- BaseExtendSelector
- Parameters:
- basedir- the base directory the scan is being done from
- filename- is the name of the file to check
- file- is a java.io.File object the selector can use
- Returns:
- whether the file should be selected or not
 
 
-