org.apache.tools.ant.types.selectors
Class PresentSelector
- FileSelector
public class PresentSelector
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).
static class | PresentSelector.FilePresence - Enumerated attribute with the values for indicating where a file's
presence is allowed and required.
|
checkAttributesAllowed , checkChildrenAllowed , circularReference , dieOnCircularReference , getCheckedRef , getDescription , getRefid , isChecked , isReference , noChildrenAllowed , setChecked , setDescription , setRefid , tooManyAttributes |
PresentSelector
public PresentSelector()
Creates a new PresentSelector
instance.
createMapper
public Mapper createMapper()
throws BuildException
Defines the FileNameMapper to use (nested mapper element).
- a mapper to be configured
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.
- isSelected in interface FileSelector
- isSelected in interface BaseSelector
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
- whether the file should be selected or not
setPresent
public void setPresent(PresentSelector.FilePresence fp)
This sets whether to select a file if its dest file is present.
It could be a negate
boolean, 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
a destonly
option.
fp
- An attribute set to either srconly
both
.
setTargetdir
public void setTargetdir(File targetdir)
The name of the file or directory which is checked for matching
files.
targetdir
- the directory to scan looking for matching files.
toString
public String toString()
- a string describing this object
verifySettings
public 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.
- verifySettings in interface BaseSelector
Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.