org.apache.tools.ant.types.selectors
Class ContainsSelector

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.ContainsSelector
All Implemented Interfaces:
ExtendFileSelector, FileSelector, Parameterizable

public class ContainsSelector
extends BaseExtendSelector

Selector that filters files based on whether they contain a particular string.

Since:
1.5

Field Summary
static java.lang.String CASE_KEY
          Used for parameterized custom selector
static java.lang.String CONTAINS_KEY
          Used for parameterized custom selector
static java.lang.String EXPRESSION_KEY
          Key to used for parameterized custom selector
static java.lang.String WHITESPACE_KEY
          Used for parameterized custom selector
 
Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
parameters
 
Fields inherited from class org.apache.tools.ant.types.DataType
checked, description, ref
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
 
Constructor Summary
ContainsSelector()
          Creates a new ContainsSelector instance.
 
Method Summary
 boolean isSelected(java.io.File basedir, java.lang.String filename, java.io.File file)
          The heart of the matter.
 void setCasesensitive(boolean casesensitive)
          Whether to ignore case in the string being searched.
 void setIgnorewhitespace(boolean ignorewhitespace)
          Whether to ignore whitespace in the string being searched.
 void setParameters(Parameter[] parameters)
          When using this as a custom selector, this method will be called.
 void setText(java.lang.String contains)
          The string to search for within a file.
 java.lang.String toString()
           
 void verifySettings()
          Checks to make sure all settings are kosher.
 
Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector
getParameters
 
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, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, log, log, setProject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EXPRESSION_KEY

public static final java.lang.String EXPRESSION_KEY
Key to used for parameterized custom selector

See Also:
Constant Field Values

CONTAINS_KEY

public static final java.lang.String CONTAINS_KEY
Used for parameterized custom selector

See Also:
Constant Field Values

CASE_KEY

public static final java.lang.String CASE_KEY
Used for parameterized custom selector

See Also:
Constant Field Values

WHITESPACE_KEY

public static final java.lang.String WHITESPACE_KEY
Used for parameterized custom selector

See Also:
Constant Field Values
Constructor Detail

ContainsSelector

public ContainsSelector()
Creates a new ContainsSelector instance.

Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
a string describing this object

setText

public void setText(java.lang.String contains)
The string to search for within a file.

Parameters:
contains - the string that a file must contain to be selected.

setCasesensitive

public void setCasesensitive(boolean casesensitive)
Whether to ignore case in the string being searched.

Parameters:
casesensitive - whether to pay attention to case sensitivity

setIgnorewhitespace

public void setIgnorewhitespace(boolean ignorewhitespace)
Whether to ignore whitespace in the string being searched.

Parameters:
ignorewhitespace - whether to ignore any whitespace (spaces, tabs, etc.) in the searchstring

setParameters

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.

Specified by:
setParameters in interface Parameterizable
Overrides:
setParameters in class BaseExtendSelector
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:
verifySettings in class BaseSelector

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:
isSelected in interface FileSelector
Specified by:
isSelected in class BaseExtendSelector
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


Copyright 2000-2005 Apache Software Foundation. All Rights Reserved.