java.lang.Cloneable
public class FilterSet extends DataType implements java.lang.Cloneable
Modifier and Type | Class | Description |
---|---|---|
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".
|
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
DEFAULT_TOKEN_END |
The default token end string
|
static java.lang.String |
DEFAULT_TOKEN_START |
The default token start string
|
description, location, project
Modifier | Constructor | Description |
---|---|---|
|
FilterSet() |
Default constructor.
|
protected |
FilterSet(FilterSet filterset) |
Create a Filterset from another filterset.
|
Modifier and Type | Method | Description |
---|---|---|
void |
addConfiguredFilterSet(FilterSet filterSet) |
Add a Filterset to this filter set.
|
void |
addConfiguredPropertySet(PropertySet propertySet) |
Adds the properties provided by the specified PropertySet to this filterset.
|
void |
addFilter(java.lang.String token,
java.lang.String value) |
Add a new filter made from the given token and value.
|
void |
addFilter(FilterSet.Filter filter) |
Add a new filter.
|
java.lang.Object |
clone() |
Clone the filterset.
|
FilterSet.FiltersFile |
createFiltersfile() |
Create a new FiltersFile.
|
java.lang.String |
getBeginToken() |
Get the begin token for this filterset.
|
java.lang.String |
getEndToken() |
Get the end token for this filterset.
|
java.util.Hashtable<java.lang.String,java.lang.String> |
getFilterHash() |
Gets the filter hash of the FilterSet.
|
protected java.util.Vector<FilterSet.Filter> |
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(java.io.File filtersFile) |
Read the filters from the given file.
|
java.lang.String |
replaceTokens(java.lang.String line) |
Does replacement on the given string with token matching.
|
void |
setBeginToken(java.lang.String startOfToken) |
Set the string used to id the beginning of a token.
|
void |
setEndToken(java.lang.String endOfToken) |
Set the string used to id the end of a token.
|
void |
setFiltersfile(java.io.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.
|
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
public static final java.lang.String DEFAULT_TOKEN_START
public static final java.lang.String DEFAULT_TOKEN_END
public FilterSet()
protected FilterSet(FilterSet filterset)
filterset
- the filterset upon which this filterset will be based.protected java.util.Vector<FilterSet.Filter> getFilters()
protected FilterSet getRef()
public java.util.Hashtable<java.lang.String,java.lang.String> getFilterHash()
public void setFiltersfile(java.io.File filtersFile) throws BuildException
filtersFile
- sets the filter file from which to read filters
for this filter set.BuildException
- if there is an error.public void setBeginToken(java.lang.String startOfToken)
startOfToken
- The new Begintoken value.public java.lang.String getBeginToken()
public void setEndToken(java.lang.String endOfToken)
endOfToken
- The new Endtoken value.public java.lang.String getEndToken()
public void setRecurse(boolean recurse)
recurse
- boolean
whether to recurse.public boolean isRecurse()
boolean
whether enabled.public void readFiltersFromFile(java.io.File filtersFile) throws BuildException
filtersFile
- the file from which filters are read.BuildException
- when the file cannot be read.public java.lang.String replaceTokens(java.lang.String line)
line
- The line in which to process embedded tokens.public void addFilter(FilterSet.Filter filter)
filter
- the filter to be added.public FilterSet.FiltersFile createFiltersfile()
public void addFilter(java.lang.String token, java.lang.String value)
token
- The token for the new filter.value
- The value for the new filter.public void addConfiguredFilterSet(FilterSet filterSet)
filterSet
- the filterset to be added to this filtersetpublic void addConfiguredPropertySet(PropertySet propertySet)
propertySet
- the propertyset to be added to this propertysetpublic boolean hasFilters()
public java.lang.Object clone() throws BuildException
clone
in class DataType
BuildException
- if the clone cannot be performed.public void setOnMissingFiltersFile(FilterSet.OnMissing onMissingFiltersFile)
onMissingFiltersFile
- the OnMissing describing the behavior.public FilterSet.OnMissing getOnMissingFiltersFile()