Class PresentSelector
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.PresentSelector
- All Implemented Interfaces:
- Cloneable,- ResourceSelector,- FileSelector
Selector that filters files based on whether they appear in another
 directory tree. It can contain a mapper element, so isn't available
 as an ExtendSelector (since those parameters can't hold other
 elements).
- Since:
- 1.5
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classEnumerated attribute with the values for indicating where a file's presence is allowed and required.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddConfigured(FileNameMapper fileNameMapper) Add a configured FileNameMapper instance.Defines the FileNameMapper to use (nested mapper element).booleanisSelected(File basedir, String filename, File file) The heart of the matter.voidThis sets whether to select a file if its dest file is present.voidsetTargetdir(File targetdir) The name of the file or directory which is checked for matching files.toString()Basic DataType toString().voidChecks to make sure all settings are kosher.Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelectorgetError, setError, setError, validateMethods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, 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.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.tools.ant.types.selectors.FileSelectorisSelected
- 
Constructor Details- 
PresentSelectorpublic PresentSelector()
 
- 
- 
Method Details- 
toString
- 
setTargetdirThe name of the file or directory which is checked for matching files.- Parameters:
- targetdir- the directory to scan looking for matching files.
 
- 
createMapperDefines the FileNameMapper to use (nested mapper element).- Returns:
- a mapper to be configured
- Throws:
- BuildException- if more than one mapper defined
 
- 
addConfiguredAdd a configured FileNameMapper instance.- Parameters:
- fileNameMapper- the FileNameMapper to add
- Throws:
- BuildException- if more than one mapper defined
- Since:
- Ant 1.8.0
 
- 
setPresentThis sets whether to select a file if its dest file is present. It could be anegateboolean, but by doing things this way, we get some documentation on how the system works. A user looking at the documentation should clearly understand that the ONLY files whose presence is being tested are those that already exist in the source directory, hence the lack of adestonlyoption.- Parameters:
- fp- An attribute set to either- srconlyor- both.
 
- 
verifySettingspublic void verifySettings()Checks to make sure all settings are kosher. In this case, it means that the targetdir attribute has been set and we have a mapper.- Overrides:
- verifySettingsin class- BaseSelector
 
- 
isSelectedThe 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 interface- FileSelector
- Specified by:
- isSelectedin class- BaseSelector
- 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
 
 
-