Package org.apache.tools.ant.types
Class FilterChain
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.FilterChain
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
FilterMapper
FilterChain may contain a chained set of filter readers.
-
Field Summary
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(ChainableReader filter) Add a chainfilter filter.void
addClassConstants
(ClassConstants classConstants) Add a ClassConstants filter.void
Add a containsregex filter.void
Add a delete characters filter.void
addEscapeUnicode
(EscapeUnicode escapeUnicode) Add an EscapeUnicode filter.void
addExpandProperties
(ExpandProperties expandProperties) Add an ExpandProperties filter.void
addFilterReader
(AntFilterReader filterReader) Add an AntFilterReader filter.void
addHeadFilter
(HeadFilter headFilter) Add a HeadFilter filter.void
Add an ignoreBlank filter.void
addLineContains
(LineContains lineContains) Add a LineContains filter.void
addLineContainsRegExp
(LineContainsRegExp lineContainsRegExp) Add a LineContainsRegExp filter.void
addPrefixLines
(PrefixLines prefixLines) Add a PrefixLines filter.void
Add a replaceregex filter.void
Add a replacestring filter.void
addReplaceTokens
(ReplaceTokens replaceTokens) Add a ReplaceTokens filter.void
addStripJavaComments
(StripJavaComments stripJavaComments) Add a StripJavaCommands filter.void
addStripLineBreaks
(StripLineBreaks stripLineBreaks) Add a StripLineBreaks filter.void
addStripLineComments
(StripLineComments stripLineComments) Add a StripLineComments filter.void
addSuffixLines
(SuffixLines suffixLines) Add a SuffixLines filter.void
addTabsToSpaces
(TabsToSpaces tabsToSpaces) Add a TabsToSpaces filter.void
addTailFilter
(TailFilter tailFilter) Add a TailFilter filter.void
addTokenFilter
(TokenFilter tokenFilter) Add a TokenFilter filter.void
addTrim
(TokenFilter.Trim filter) Add a trim filter.protected void
dieOnCircularReference
(Stack<Object> stk, Project p) Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).Return the filters.void
Makes this instance in effect a reference to another FilterChain instance.Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
Methods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Constructor Details
-
FilterChain
public FilterChain()
-
-
Method Details
-
addFilterReader
Add an AntFilterReader filter.- Parameters:
filterReader
- anAntFilterReader
value
-
getFilterReaders
Return the filters.- Returns:
- a
Vector
value containing the filters
-
addClassConstants
Add a ClassConstants filter.- Parameters:
classConstants
- aClassConstants
value
-
addExpandProperties
Add an ExpandProperties filter.- Parameters:
expandProperties
- anExpandProperties
value
-
addHeadFilter
Add a HeadFilter filter.- Parameters:
headFilter
- aHeadFilter
value
-
addLineContains
Add a LineContains filter.- Parameters:
lineContains
- aLineContains
value
-
addLineContainsRegExp
Add a LineContainsRegExp filter.- Parameters:
lineContainsRegExp
- aLineContainsRegExp
value
-
addPrefixLines
Add a PrefixLines filter.- Parameters:
prefixLines
- aPrefixLines
value
-
addSuffixLines
Add a SuffixLines filter.- Parameters:
suffixLines
- aSuffixLines
value- Since:
- Ant 1.8.0
-
addReplaceTokens
Add a ReplaceTokens filter.- Parameters:
replaceTokens
- aReplaceTokens
value
-
addStripJavaComments
Add a StripJavaCommands filter.- Parameters:
stripJavaComments
- aStripJavaComments
value
-
addStripLineBreaks
Add a StripLineBreaks filter.- Parameters:
stripLineBreaks
- aStripLineBreaks
value
-
addStripLineComments
Add a StripLineComments filter.- Parameters:
stripLineComments
- aStripLineComments
value
-
addTabsToSpaces
Add a TabsToSpaces filter.- Parameters:
tabsToSpaces
- aTabsToSpaces
value
-
addTailFilter
Add a TailFilter filter.- Parameters:
tailFilter
- aTailFilter
value
-
addEscapeUnicode
Add an EscapeUnicode filter.- Parameters:
escapeUnicode
- anEscapeUnicode
value- Since:
- Ant 1.6
-
addTokenFilter
Add a TokenFilter filter.- Parameters:
tokenFilter
- aTokenFilter
value- Since:
- Ant 1.6
-
addDeleteCharacters
Add a delete characters filter.- Parameters:
filter
- aTokenFilter.DeleteCharacters
value- Since:
- Ant 1.6
-
addContainsRegex
Add a containsregex filter.- Parameters:
filter
- aTokenFilter.ContainsRegex
value- Since:
- Ant 1.6
-
addReplaceRegex
Add a replaceregex filter.- Parameters:
filter
- aTokenFilter.ReplaceRegex
value
-
addTrim
Add a trim filter.- Parameters:
filter
- aTokenFilter.Trim
value- Since:
- Ant 1.6
-
addReplaceString
Add a replacestring filter.- Parameters:
filter
- aTokenFilter.ReplaceString
value- Since:
- Ant 1.6
-
addIgnoreBlank
Add an ignoreBlank filter.- Parameters:
filter
- aTokenFilter.IgnoreBlank
value- Since:
- Ant 1.6
-
setRefid
Makes this instance in effect a reference to another FilterChain instance.You must not set another attribute or nest elements inside this element if you make it a reference.
- Overrides:
setRefid
in classDataType
- Parameters:
r
- the reference to which this instance is associated- Throws:
BuildException
- if this instance already has been configured.
-
add
Add a chainfilter filter.- Parameters:
filter
- aChainableReader
value- Since:
- Ant 1.6
-
dieOnCircularReference
Description copied from class:DataType
Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).If one is included, throw a BuildException created by
circularReference
.This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if
DataType.checked
is true and set it to true on exit.- Overrides:
dieOnCircularReference
in classDataType
- Parameters:
stk
- the stack of references to check.p
- the project to use to dereference the references.- Throws:
BuildException
- on error.
-