org.apache.tools.ant.types.selectors

Class DepthSelector

public class DepthSelector extends BaseExtendSelector

Selector that filters files based on the how deep in the directory tree they are.

Since: 1.5

Field Summary
int	max max attribute
int	min min attribute
static String	MAX_KEY Used for parameterized custom selector
static String	MIN_KEY Used for parameterized custom selector

Constructor Summary
	DepthSelector() Creates a new `DepthSelector` instance.

Method Summary
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.

Field Detail

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

Constructor Detail

DepthSelector

public DepthSelector()

Creates a new DepthSelector instance.

Method Detail

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.

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

setMax

public void setMax(int max)

The minimum depth below the basedir before a file is selected.

Parameters: 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.

Parameters: 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.

Parameters: parameters the complete set of parameters for this selector

toString

public String toString()

Returns: 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.