Save This Page
Home » apache-ant-1.8.1 » org.apache.tools » ant » types » selectors » [javadoc | source]
org.apache.tools.ant.types.selectors
public class: FilenameSelector [javadoc | source]
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.FilenameSelector

All Implemented Interfaces:
    ExtendFileSelector, FileSelector, Cloneable

Selector that filters files based on the filename.
Field Summary
public static final  String NAME_KEY    Used for parameterized custom selector 
public static final  String CASE_KEY    Used for parameterized custom selector 
public static final  String NEGATE_KEY    Used for parameterized custom selector 
public static final  String REGEX_KEY    Used for parameterized custom selector 
Fields inherited from org.apache.tools.ant.types.selectors.BaseExtendSelector:
parameters
Fields inherited from org.apache.tools.ant.types.DataType:
ref,  checked
Fields inherited from org.apache.tools.ant.ProjectComponent:
project,  location,  description
Constructor:
 public FilenameSelector() 
Method from org.apache.tools.ant.types.selectors.FilenameSelector Summary:
isSelected,   setCasesensitive,   setName,   setNegate,   setParameters,   setRegex,   toString,   verifySettings
Methods from org.apache.tools.ant.types.selectors.BaseExtendSelector:
getParameters,   isSelected,   setParameters
Methods from org.apache.tools.ant.types.selectors.BaseSelector:
getError,   isSelected,   setError,   validate,   verifySettings
Methods from 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,   toString,   tooManyAttributes
Methods from org.apache.tools.ant.ProjectComponent:
clone,   getDescription,   getLocation,   getProject,   log,   log,   setDescription,   setLocation,   setProject
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tools.ant.types.selectors.FilenameSelector Detail:
 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. Most of the work for this selector is offloaded into SelectorUtils, a static class that provides the same services for both FilenameSelector and DirectoryScanner.
 public  void setCasesensitive(boolean casesensitive) 
    Whether to ignore case when checking filenames.
 public  void setName(String pattern) 
    The name of the file, or the pattern for the name, that should be used for selection.
 public  void setNegate(boolean negated) 
    You can optionally reverse the selection of this selector, thereby emulating an <exclude> tag, by setting the attribute negate to true. This is identical to surrounding the selector with <not></not>.
 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.
 public  void setRegex(String pattern) 
    The regular expression the file name will be matched against.
 public String toString() 
 public  void verifySettings() 
    Checks to make sure all settings are kosher. In this case, it means that the name attribute has been set.