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:
java.lang.Cloneable
- Direct Known Subclasses:
FilterMapper
public class FilterChain extends DataType
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
Constructors Constructor Description FilterChain()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(ChainableReader filter)
Add a chainfilter filter.void
addClassConstants(ClassConstants classConstants)
Add a ClassConstants filter.void
addContainsRegex(TokenFilter.ContainsRegex filter)
Add a containsregex filter.void
addDeleteCharacters(TokenFilter.DeleteCharacters filter)
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
addIgnoreBlank(TokenFilter.IgnoreBlank filter)
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
addReplaceRegex(TokenFilter.ReplaceRegex filter)
Add a replaceregex filter.void
addReplaceString(TokenFilter.ReplaceString filter)
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(java.util.Stack<java.lang.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).java.util.Vector<java.lang.Object>
getFilterReaders()
Return the filters.void
setRefid(Reference r)
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
-
-
-
-
Method Detail
-
addFilterReader
public void addFilterReader(AntFilterReader filterReader)
Add an AntFilterReader filter.- Parameters:
filterReader
- anAntFilterReader
value
-
getFilterReaders
public java.util.Vector<java.lang.Object> getFilterReaders()
Return the filters.- Returns:
- a
Vector
value containing the filters
-
addClassConstants
public void addClassConstants(ClassConstants classConstants)
Add a ClassConstants filter.- Parameters:
classConstants
- aClassConstants
value
-
addExpandProperties
public void addExpandProperties(ExpandProperties expandProperties)
Add an ExpandProperties filter.- Parameters:
expandProperties
- anExpandProperties
value
-
addHeadFilter
public void addHeadFilter(HeadFilter headFilter)
Add a HeadFilter filter.- Parameters:
headFilter
- aHeadFilter
value
-
addLineContains
public void addLineContains(LineContains lineContains)
Add a LineContains filter.- Parameters:
lineContains
- aLineContains
value
-
addLineContainsRegExp
public void addLineContainsRegExp(LineContainsRegExp lineContainsRegExp)
Add a LineContainsRegExp filter.- Parameters:
lineContainsRegExp
- aLineContainsRegExp
value
-
addPrefixLines
public void addPrefixLines(PrefixLines prefixLines)
Add a PrefixLines filter.- Parameters:
prefixLines
- aPrefixLines
value
-
addSuffixLines
public void addSuffixLines(SuffixLines suffixLines)
Add a SuffixLines filter.- Parameters:
suffixLines
- aSuffixLines
value- Since:
- Ant 1.8.0
-
addReplaceTokens
public void addReplaceTokens(ReplaceTokens replaceTokens)
Add a ReplaceTokens filter.- Parameters:
replaceTokens
- aReplaceTokens
value
-
addStripJavaComments
public void addStripJavaComments(StripJavaComments stripJavaComments)
Add a StripJavaCommands filter.- Parameters:
stripJavaComments
- aStripJavaComments
value
-
addStripLineBreaks
public void addStripLineBreaks(StripLineBreaks stripLineBreaks)
Add a StripLineBreaks filter.- Parameters:
stripLineBreaks
- aStripLineBreaks
value
-
addStripLineComments
public void addStripLineComments(StripLineComments stripLineComments)
Add a StripLineComments filter.- Parameters:
stripLineComments
- aStripLineComments
value
-
addTabsToSpaces
public void addTabsToSpaces(TabsToSpaces tabsToSpaces)
Add a TabsToSpaces filter.- Parameters:
tabsToSpaces
- aTabsToSpaces
value
-
addTailFilter
public void addTailFilter(TailFilter tailFilter)
Add a TailFilter filter.- Parameters:
tailFilter
- aTailFilter
value
-
addEscapeUnicode
public void addEscapeUnicode(EscapeUnicode escapeUnicode)
Add an EscapeUnicode filter.- Parameters:
escapeUnicode
- anEscapeUnicode
value- Since:
- Ant 1.6
-
addTokenFilter
public void addTokenFilter(TokenFilter tokenFilter)
Add a TokenFilter filter.- Parameters:
tokenFilter
- aTokenFilter
value- Since:
- Ant 1.6
-
addDeleteCharacters
public void addDeleteCharacters(TokenFilter.DeleteCharacters filter)
Add a delete characters filter.- Parameters:
filter
- aTokenFilter.DeleteCharacters
value- Since:
- Ant 1.6
-
addContainsRegex
public void addContainsRegex(TokenFilter.ContainsRegex filter)
Add a containsregex filter.- Parameters:
filter
- aTokenFilter.ContainsRegex
value- Since:
- Ant 1.6
-
addReplaceRegex
public void addReplaceRegex(TokenFilter.ReplaceRegex filter)
Add a replaceregex filter.- Parameters:
filter
- aTokenFilter.ReplaceRegex
value
-
addTrim
public void addTrim(TokenFilter.Trim filter)
Add a trim filter.- Parameters:
filter
- aTokenFilter.Trim
value- Since:
- Ant 1.6
-
addReplaceString
public void addReplaceString(TokenFilter.ReplaceString filter)
Add a replacestring filter.- Parameters:
filter
- aTokenFilter.ReplaceString
value- Since:
- Ant 1.6
-
addIgnoreBlank
public void addIgnoreBlank(TokenFilter.IgnoreBlank filter)
Add an ignoreBlank filter.- Parameters:
filter
- aTokenFilter.IgnoreBlank
value- Since:
- Ant 1.6
-
setRefid
public void setRefid(Reference r) throws BuildException
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
public void add(ChainableReader filter)
Add a chainfilter filter.- Parameters:
filter
- aChainableReader
value- Since:
- Ant 1.6
-
dieOnCircularReference
protected void dieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p) throws BuildException
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.
-
-