Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.types.selectors

Class TypeSelector

Implemented Interfaces:
ExtendFileSelector, FileSelector, Parameterizable
public class TypeSelector
extends BaseExtendSelector
Selector that selects a certain kind of file: directory or regular.
Since:
1.6

Nested Class Summary

static class
TypeSelector.FileType
Enumerated attribute with the values for types of file

Field Summary

static String
TYPE_KEY
Key to used for parameterized custom selector

Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

parameters

Fields inherited from class org.apache.tools.ant.types.DataType

checked, description, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

TypeSelector()
Creates a new TypeSelector instance.

Method Summary

boolean
isSelected(File basedir, String filename, File file)
The heart of the matter.
void
setParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
void
setType(TypeSelector.FileType fileTypes)
Set the type of file to require.
String
toString()
void
verifySettings()
Checks to make sure all settings are kosher.

Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

getParameters, isSelected, setParameters

Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector

getError, isSelected, setError, validate, verifySettings

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

TYPE_KEY

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

Constructor Details

TypeSelector

public TypeSelector()
Creates a new TypeSelector instance.

Method Details

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.
Specified by:
isSelected in interface FileSelector
Overrides:
isSelected in interface 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

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.
Specified by:
setParameters in interface Parameterizable
Overrides:
setParameters in interface BaseExtendSelector
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.
Overrides:
verifySettings in interface BaseSelector

Overview Package Tree Index Deprecated About
Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.