Class TypeSelector
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.selectors.BaseSelector
org.apache.tools.ant.types.selectors.BaseExtendSelector
org.apache.tools.ant.types.selectors.TypeSelector
- All Implemented Interfaces:
java.lang.Cloneable,Parameterizable,ResourceSelector,ExtendFileSelector,FileSelector
public class TypeSelector extends BaseExtendSelector
Selector that selects a certain kind of file: directory or regular.
- Since:
- 1.6
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTypeSelector.FileTypeEnumerated attribute with the values for types of file -
Field Summary
Fields Modifier and Type Field Description static java.lang.StringTYPE_KEYKey to used for parameterized custom selector -
Constructor Summary
Constructors Constructor Description TypeSelector() -
Method Summary
Modifier and Type Method Description booleanisSelected(java.io.File basedir, java.lang.String filename, java.io.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.java.lang.StringtoString()Basic DataType toString().voidverifySettings()Checks to make sure all settings are kosher.Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector
getError, setError, setError, validateMethods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Field Details
-
TYPE_KEY
public static final java.lang.String TYPE_KEYKey to used for parameterized custom selector- See Also:
- Constant Field Values
-
-
Constructor Details
-
TypeSelector
public TypeSelector()
-
-
Method Details
-
toString
public java.lang.String toString()Description copied from class:DataTypeBasic DataType toString(). -
setType
Set the type of file to require.- Parameters:
fileTypes- the type of file - file or dir
-
setParameters
When using this as a custom selector, this method will be called. It translates each parameter into the appropriate setXXX() call.- Specified by:
setParametersin interfaceParameterizable- Overrides:
setParametersin classBaseExtendSelector- Parameters:
parameters- the complete set of parameters for this selector
-
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:
verifySettingsin classBaseSelector
-
isSelected
public boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.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:
isSelectedin interfaceFileSelector- Specified by:
isSelectedin classBaseExtendSelector- Parameters:
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- Returns:
- whether the file should be selected or not
-