org.apache.tools.ant.types.selectors

Class ContainsSelector

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 String
CASE_KEY
Used for parameterized custom selector
static String
CONTAINS_KEY
Used for parameterized custom selector
static String
EXPRESSION_KEY
Key to used for parameterized custom selector
static 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(File basedir, String filename, 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(String contains)
The string to search for within a file.
String
toString()
void
verifySettings()
Checks to make sure all settings are kosher.

Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

getParameters, isSelected, setParameters

Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector

getError, isSelected, setError, validate, verifySettings

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

Field Details

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 Details

ContainsSelector

public ContainsSelector()
Creates a new ContainsSelector instance.

Method Details

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.
Specified by:
isSelected in interface FileSelector
Overrides:
isSelected in interface 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

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 interface BaseExtendSelector
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.
Overrides:
verifySettings in interface BaseSelector

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.