org.apache.tools.ant.types.selectors
Class DepthSelector
- ExtendFileSelector, FileSelector, Parameterizable
public class DepthSelector
Selector that filters files based on the how deep in the directory
tree they are.
static String | MAX_KEY - Used for parameterized custom selector
|
static String | MIN_KEY - Used for parameterized custom selector
|
int | max
|
int | min
|
boolean | isSelected(File basedir, String filename, File file) - The heart of the matter.
|
void | setMax(int max) - The minimum depth below the basedir before a file is selected.
|
void | setMin(int min) - The minimum depth below the basedir before a file is selected.
|
void | setParameters(Parameter[] parameters) - When using this as a custom selector, this method will be called.
|
String | toString()
|
void | verifySettings() - Checks to make sure all settings are kosher.
|
checkAttributesAllowed , checkChildrenAllowed , circularReference , dieOnCircularReference , getCheckedRef , getDescription , getRefid , isChecked , isReference , noChildrenAllowed , setChecked , setDescription , setRefid , tooManyAttributes |
MAX_KEY
public static final String MAX_KEY
Used for parameterized custom selector
MIN_KEY
public static final String MIN_KEY
Used for parameterized custom selector
DepthSelector
public DepthSelector()
Creates a new DepthSelector
instance.
isSelected
public boolean isSelected(File basedir,
String filename,
File file)
The 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.
- isSelected in interface FileSelector
- isSelected in interface BaseExtendSelector
basedir
- the base directory the scan is being done fromfilename
- is the name of the file to checkfile
- is a java.io.File object the selector can use
- whether the file should be selected or not
setMax
public void setMax(int max)
The minimum depth below the basedir before a file is selected.
max
- maximum directory levels below basedir to go
setMin
public void setMin(int min)
The minimum depth below the basedir before a file is selected.
min
- minimum directory levels below basedir to go
setParameters
public void setParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
It translates each parameter into the appropriate setXXX() call.
- setParameters in interface Parameterizable
- setParameters in interface BaseExtendSelector
parameters
- the complete set of parameters for this selector
toString
public String toString()
- a string describing this object
verifySettings
public 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.
- verifySettings in interface BaseSelector
Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.