org.apache.tools.ant.types
public class FilterSet extends DataType implements Cloneable
Nested Class Summary | |
---|---|
static class | FilterSet.Filter
Individual filter component of filterset.
|
class | FilterSet.FiltersFile
The filtersfile nested element.
|
static class | FilterSet.OnMissing
EnumeratedAttribute to set behavior WRT missing filtersfiles:
"fail" (default), "warn", "ignore". |
Field Summary | |
---|---|
static String | DEFAULT_TOKEN_END The default token end string |
static String | DEFAULT_TOKEN_START The default token start string |
Constructor Summary | |
---|---|
FilterSet()
Default constructor. | |
protected | FilterSet(FilterSet filterset)
Create a Filterset from another filterset.
|
Method Summary | |
---|---|
void | addConfiguredFilterSet(FilterSet filterSet)
Add a Filterset to this filter set.
|
void | addFilter(FilterSet.Filter filter)
Add a new filter.
|
void | addFilter(String token, String value)
Add a new filter made from the given token and value.
|
Object | clone()
Clone the filterset.
|
FilterSet.FiltersFile | createFiltersfile()
Create a new FiltersFile.
|
String | getBeginToken()
Get the begin token for this filterset.
|
String | getEndToken()
Get the end token for this filterset.
|
Hashtable | getFilterHash()
Gets the filter hash of the FilterSet.
|
protected Vector | getFilters()
Get the filters in the filter set.
|
FilterSet.OnMissing | getOnMissingFiltersFile()
Get the onMissingFiltersFile setting. |
protected FilterSet | getRef()
Get the referenced filter set.
|
boolean | hasFilters()
Test to see if this filter set has filters.
|
boolean | isRecurse()
Get whether recursive token expansion is enabled. |
void | readFiltersFromFile(File filtersFile)
Read the filters from the given file.
|
String | replaceTokens(String line)
Does replacement on the given string with token matching.
|
void | setBeginToken(String startOfToken)
Set the string used to id the beginning of a token.
|
void | setEndToken(String endOfToken)
Set the string used to id the end of a token.
|
void | setFiltersfile(File filtersFile)
Set the file containing the filters for this filterset.
|
void | setOnMissingFiltersFile(FilterSet.OnMissing onMissingFiltersFile)
Set the behavior WRT missing filtersfiles. |
void | setRecurse(boolean recurse)
Set whether recursive token expansion is enabled. |
Parameters: filterset the filterset upon which this filterset will be based.
Parameters: filterSet the filterset to be added to this filterset
Parameters: filter the filter to be added.
Parameters: token The token for the new filter. value The value for the new filter.
Returns: a deep clone of this filterset.
Throws: BuildException if the clone cannot be performed.
Returns: The filtersfile that was created.
Returns: the filter set's begin token for filtering.
Returns: the filter set's end token for replacement delimiting.
Returns: The hash of the tokens and values for quick lookup.
Returns: a Vector of Filter instances.
Returns: the OnMissing instance.
Returns: the filterset from the reference.
Returns: Return true if there are filters in this set.
Returns: boolean
whether enabled.
Parameters: filtersFile the file from which filters are read.
Throws: BuildException when the file cannot be read.
Parameters: line The line in which to process embedded tokens.
Returns: The input string after token replacement.
Parameters: startOfToken The new Begintoken value.
Parameters: endOfToken The new Endtoken value.
Parameters: filtersFile sets the filter file from which to read filters for this filter set.
Throws: BuildException if there is an error.
Parameters: onMissingFiltersFile the OnMissing describing the behavior.
Parameters: recurse boolean
whether to recurse.