org.apache.tools.ant.types.selectors

Class TypeSelector

public class TypeSelector extends BaseExtendSelector

Selector that selects a certain kind of file: directory or regular.

Since: 1.6

Nested Class Summary
static classTypeSelector.FileType
Enumerated attribute with the values for types of file
Field Summary
static StringTYPE_KEY
Key to used for parameterized custom selector
Constructor Summary
TypeSelector()
Creates a new TypeSelector instance.
Method Summary
booleanisSelected(File basedir, String filename, File file)
The heart of the matter.
voidsetParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
voidsetType(TypeSelector.FileType fileTypes)
Set the type of file to require.
StringtoString()
voidverifySettings()
Checks to make sure all settings are kosher.

Field Detail

TYPE_KEY

public static final String TYPE_KEY
Key to used for parameterized custom selector

Constructor Detail

TypeSelector

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

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

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

setType

public void setType(TypeSelector.FileType fileTypes)
Set the type of file to require.

Parameters: fileTypes the type of file - file or dir

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