org.apache.tools.ant.types.selectors

Class ContainsSelector

public class ContainsSelector extends BaseExtendSelector

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

Since: 1.5

Field Summary
static StringCASE_KEY
Used for parameterized custom selector
static StringCONTAINS_KEY
Used for parameterized custom selector
static StringEXPRESSION_KEY
Key to used for parameterized custom selector
static StringWHITESPACE_KEY
Used for parameterized custom selector
Constructor Summary
ContainsSelector()
Creates a new ContainsSelector instance.
Method Summary
booleanisSelected(File basedir, String filename, File file)
The heart of the matter.
voidsetCasesensitive(boolean casesensitive)
Whether to ignore case in the string being searched.
voidsetIgnorewhitespace(boolean ignorewhitespace)
Whether to ignore whitespace in the string being searched.
voidsetParameters(Parameter[] parameters)
When using this as a custom selector, this method will be called.
voidsetText(String contains)
The string to search for within a file.
StringtoString()
voidverifySettings()
Checks to make sure all settings are kosher.

Field Detail

CASE_KEY

public static final String CASE_KEY
Used for parameterized custom selector

CONTAINS_KEY

public static final String CONTAINS_KEY
Used for parameterized custom selector

EXPRESSION_KEY

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

WHITESPACE_KEY

public static final String WHITESPACE_KEY
Used for parameterized custom selector

Constructor Detail

ContainsSelector

public ContainsSelector()
Creates a new ContainsSelector instance.

Method Detail

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.

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

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.

Parameters: parameters the complete set of parameters for this selector

setText

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

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

toString

public String toString()

Returns: a string describing this object

verifySettings

public void verifySettings()
Checks to make sure all settings are kosher. In this case, it means that the pattern attribute has been set.
Copyright