| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.selectors.BaseSelector
org.apache.tools.ant.types.selectors.PresentSelector
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).
| Nested Class Summary | |
|---|---|
| static class | PresentSelector.FilePresenceEnumerated attribute with the values for indicating where a file's presence is allowed and required. | 
| Field Summary | 
|---|
| Fields inherited from class org.apache.tools.ant.types.DataType | 
|---|
| checked, ref | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| description, location, project | 
| Constructor Summary | |
|---|---|
| PresentSelector()Creates a new PresentSelectorinstance. | |
| Method Summary | |
|---|---|
|  void | addConfigured(FileNameMapper fileNameMapper)Add a configured FileNameMapper instance. | 
|  Mapper | createMapper()Defines the FileNameMapper to use (nested mapper element). | 
|  boolean | isSelected(java.io.File basedir,
           java.lang.String filename,
           java.io.File file)The heart of the matter. | 
|  void | setPresent(PresentSelector.FilePresence fp)This sets whether to select a file if its dest file is present. | 
|  void | setTargetdir(java.io.File targetdir)The name of the file or directory which is checked for matching files. | 
|  java.lang.String | toString()Basic DataType toString(). | 
|  void | verifySettings()Checks to make sure all settings are kosher. | 
| Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector | 
|---|
| getError, setError, validate | 
| Methods inherited from class org.apache.tools.ant.types.DataType | 
|---|
| checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Constructor Detail | 
|---|
public PresentSelector()
PresentSelector instance.
| Method Detail | 
|---|
public java.lang.String toString()
DataType
toString in class DataTypepublic void setTargetdir(java.io.File targetdir)
targetdir - the directory to scan looking for matching files.
public Mapper createMapper()
                    throws BuildException
BuildException - if more than one mapper definedpublic void addConfigured(FileNameMapper fileNameMapper)
fileNameMapper - the FileNameMapper to add
BuildException - if more than one mapper definedpublic void setPresent(PresentSelector.FilePresence fp)
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 srconlyboth.public void verifySettings()
verifySettings in class BaseSelector
public boolean isSelected(java.io.File basedir,
                          java.lang.String filename,
                          java.io.File file)
isSelected in interface FileSelectorisSelected in class BaseSelectorbasedir - 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
| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||