A set of filters to be applied to something.
A filter set may have begintoken and endtokens defined.
addConfiguredFilterSet
public void addConfiguredFilterSet(FilterSet filterSet)
Add a Filterset to this filter set.
filterSet
- the filterset to be added to this filterset
addFilter
public void addFilter(String token,
String value)
Add a new filter made from the given token and value.
token
- The token for the new filter.value
- The value for the new filter.
addFilter
public void addFilter(FilterSet.Filter filter)
Add a new filter.
filter
- the filter to be added.
clone
public Object clone()
throws BuildException
Clone the filterset.
- a deep clone of this filterset.
createFiltersfile
public FilterSet.FiltersFile createFiltersfile()
Create a new FiltersFile.
- The filtersfile that was created.
getBeginToken
public String getBeginToken()
Get the begin token for this filterset.
- the filter set's begin token for filtering.
getEndToken
public String getEndToken()
Get the end token for this filterset.
- the filter set's end token for replacement delimiting.
getFilterHash
public Hashtable getFilterHash()
Gets the filter hash of the FilterSet.
- The hash of the tokens and values for quick lookup.
getFilters
protected Vector getFilters()
Get the filters in the filter set.
- a Vector of Filter instances.
getRef
protected FilterSet getRef()
Get the referenced filter set.
- the filterset from the reference.
hasFilters
public boolean hasFilters()
Test to see if this filter set has filters.
- Return true if there are filters in this set.
isRecurse
public boolean isRecurse()
Get whether recursive token expansion is enabled.
readFiltersFromFile
public void readFiltersFromFile(File filtersFile)
throws BuildException
Read the filters from the given file.
filtersFile
- the file from which filters are read.
replaceTokens
public String replaceTokens(String line)
Does replacement on the given string with token matching.
This uses the defined begintoken and endtoken values which default
to @ for both.
This resets the passedTokens and calls iReplaceTokens to
do the actual replacements.
line
- The line in which to process embedded tokens.
- The input string after token replacement.
setBeginToken
public void setBeginToken(String startOfToken)
Set the string used to id the beginning of a token.
startOfToken
- The new Begintoken value.
setEndToken
public void setEndToken(String endOfToken)
Set the string used to id the end of a token.
endOfToken
- The new Endtoken value.
setFiltersfile
public void setFiltersfile(File filtersFile)
throws BuildException
Set the file containing the filters for this filterset.
filtersFile
- sets the filter file from which to read filters
for this filter set.
setRecurse
public void setRecurse(boolean recurse)
Set whether recursive token expansion is enabled.
recurse
- boolean
whether to recurse.