org.apache.tools.ant.types.selectors

Class FilenameSelector

public class FilenameSelector extends BaseExtendSelector

Selector that filters files based on the filename.

Since: 1.5

Field Summary
static StringCASE_KEY
Used for parameterized custom selector
static StringNAME_KEY
Used for parameterized custom selector
static StringNEGATE_KEY
Used for parameterized custom selector
static StringREGEX_KEY
Used for parameterized custom selector
Constructor Summary
FilenameSelector()
Creates a new FilenameSelector instance.
Method Summary
booleanisSelected(File basedir, String filename, File file)
The heart of the matter.
voidsetCasesensitive(boolean casesensitive)
Whether to ignore case when checking filenames.
voidsetName(String pattern)
The name of the file, or the pattern for the name, that should be used for selection.
voidsetNegate(boolean negated)
You can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true.
voidsetParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
voidsetRegex(String pattern)
The regular expression the file name will be matched against.
StringtoString()
voidverifySettings()
Checks to make sure all settings are kosher.

Field Detail

CASE_KEY

public static final String CASE_KEY
Used for parameterized custom selector

NAME_KEY

public static final String NAME_KEY
Used for parameterized custom selector

NEGATE_KEY

public static final String NEGATE_KEY
Used for parameterized custom selector

REGEX_KEY

public static final String REGEX_KEY
Used for parameterized custom selector

Constructor Detail

FilenameSelector

public FilenameSelector()
Creates a new FilenameSelector 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

setCasesensitive

public void setCasesensitive(boolean casesensitive)
Whether to ignore case when checking filenames.

Parameters: casesensitive whether to pay attention to case sensitivity

setName

public void setName(String pattern)
The name of the file, or the pattern for the name, that should be used for selection.

Parameters: pattern the file pattern that any filename must match against in order to be selected.

setNegate

public void setNegate(boolean negated)
You can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true. This is identical to surrounding the selector with <not></not>.

Parameters: negated whether to negate this selection

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

setRegex

public void setRegex(String pattern)
The regular expression the file name will be matched against.

Parameters: pattern the regular expression that any filename must match against in order to be selected.

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 name attribute has been set.