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.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description FilterChain()
 - 
Method SummaryModifier and Type Method Description voidadd(ChainableReader filter)Add a chainfilter filter.voidaddClassConstants(ClassConstants classConstants)Add a ClassConstants filter.voidaddContainsRegex(TokenFilter.ContainsRegex filter)Add a containsregex filter.voidaddDeleteCharacters(TokenFilter.DeleteCharacters filter)Add a delete characters filter.voidaddEscapeUnicode(EscapeUnicode escapeUnicode)Add an EscapeUnicode filter.voidaddExpandProperties(ExpandProperties expandProperties)Add an ExpandProperties filter.voidaddFilterReader(AntFilterReader filterReader)Add an AntFilterReader filter.voidaddHeadFilter(HeadFilter headFilter)Add a HeadFilter filter.voidaddIgnoreBlank(TokenFilter.IgnoreBlank filter)Add an ignoreBlank filter.voidaddLineContains(LineContains lineContains)Add a LineContains filter.voidaddLineContainsRegExp(LineContainsRegExp lineContainsRegExp)Add a LineContainsRegExp filter.voidaddPrefixLines(PrefixLines prefixLines)Add a PrefixLines filter.voidaddReplaceRegex(TokenFilter.ReplaceRegex filter)Add a replaceregex filter.voidaddReplaceString(TokenFilter.ReplaceString filter)Add a replacestring filter.voidaddReplaceTokens(ReplaceTokens replaceTokens)Add a ReplaceTokens filter.voidaddStripJavaComments(StripJavaComments stripJavaComments)Add a StripJavaCommands filter.voidaddStripLineBreaks(StripLineBreaks stripLineBreaks)Add a StripLineBreaks filter.voidaddStripLineComments(StripLineComments stripLineComments)Add a StripLineComments filter.voidaddSuffixLines(SuffixLines suffixLines)Add a SuffixLines filter.voidaddTabsToSpaces(TabsToSpaces tabsToSpaces)Add a TabsToSpaces filter.voidaddTailFilter(TailFilter tailFilter)Add a TailFilter filter.voidaddTokenFilter(TokenFilter tokenFilter)Add a TokenFilter filter.voidaddTrim(TokenFilter.Trim filter)Add a trim filter.protected voiddieOnCircularReference(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.voidsetRefid(Reference r)Makes this instance in effect a reference to another FilterChain instance.- 
Methods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, 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.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Method Detail- 
addFilterReaderpublic void addFilterReader(AntFilterReader filterReader) Add an AntFilterReader filter.- Parameters:
- filterReader- an- AntFilterReadervalue
 
 - 
getFilterReaderspublic java.util.Vector<java.lang.Object> getFilterReaders() Return the filters.- Returns:
- a Vectorvalue containing the filters
 
 - 
addClassConstantspublic void addClassConstants(ClassConstants classConstants) Add a ClassConstants filter.- Parameters:
- classConstants- a- ClassConstantsvalue
 
 - 
addExpandPropertiespublic void addExpandProperties(ExpandProperties expandProperties) Add an ExpandProperties filter.- Parameters:
- expandProperties- an- ExpandPropertiesvalue
 
 - 
addHeadFilterpublic void addHeadFilter(HeadFilter headFilter) Add a HeadFilter filter.- Parameters:
- headFilter- a- HeadFiltervalue
 
 - 
addLineContainspublic void addLineContains(LineContains lineContains) Add a LineContains filter.- Parameters:
- lineContains- a- LineContainsvalue
 
 - 
addLineContainsRegExppublic void addLineContainsRegExp(LineContainsRegExp lineContainsRegExp) Add a LineContainsRegExp filter.- Parameters:
- lineContainsRegExp- a- LineContainsRegExpvalue
 
 - 
addPrefixLinespublic void addPrefixLines(PrefixLines prefixLines) Add a PrefixLines filter.- Parameters:
- prefixLines- a- PrefixLinesvalue
 
 - 
addSuffixLinespublic void addSuffixLines(SuffixLines suffixLines) Add a SuffixLines filter.- Parameters:
- suffixLines- a- SuffixLinesvalue
- Since:
- Ant 1.8.0
 
 - 
addReplaceTokenspublic void addReplaceTokens(ReplaceTokens replaceTokens) Add a ReplaceTokens filter.- Parameters:
- replaceTokens- a- ReplaceTokensvalue
 
 - 
addStripJavaCommentspublic void addStripJavaComments(StripJavaComments stripJavaComments) Add a StripJavaCommands filter.- Parameters:
- stripJavaComments- a- StripJavaCommentsvalue
 
 - 
addStripLineBreakspublic void addStripLineBreaks(StripLineBreaks stripLineBreaks) Add a StripLineBreaks filter.- Parameters:
- stripLineBreaks- a- StripLineBreaksvalue
 
 - 
addStripLineCommentspublic void addStripLineComments(StripLineComments stripLineComments) Add a StripLineComments filter.- Parameters:
- stripLineComments- a- StripLineCommentsvalue
 
 - 
addTabsToSpacespublic void addTabsToSpaces(TabsToSpaces tabsToSpaces) Add a TabsToSpaces filter.- Parameters:
- tabsToSpaces- a- TabsToSpacesvalue
 
 - 
addTailFilterpublic void addTailFilter(TailFilter tailFilter) Add a TailFilter filter.- Parameters:
- tailFilter- a- TailFiltervalue
 
 - 
addEscapeUnicodepublic void addEscapeUnicode(EscapeUnicode escapeUnicode) Add an EscapeUnicode filter.- Parameters:
- escapeUnicode- an- EscapeUnicodevalue
- Since:
- Ant 1.6
 
 - 
addTokenFilterpublic void addTokenFilter(TokenFilter tokenFilter) Add a TokenFilter filter.- Parameters:
- tokenFilter- a- TokenFiltervalue
- Since:
- Ant 1.6
 
 - 
addDeleteCharacterspublic void addDeleteCharacters(TokenFilter.DeleteCharacters filter) Add a delete characters filter.- Parameters:
- filter- a- TokenFilter.DeleteCharactersvalue
- Since:
- Ant 1.6
 
 - 
addContainsRegexpublic void addContainsRegex(TokenFilter.ContainsRegex filter) Add a containsregex filter.- Parameters:
- filter- a- TokenFilter.ContainsRegexvalue
- Since:
- Ant 1.6
 
 - 
addReplaceRegexpublic void addReplaceRegex(TokenFilter.ReplaceRegex filter) Add a replaceregex filter.- Parameters:
- filter- a- TokenFilter.ReplaceRegexvalue
 
 - 
addTrimpublic void addTrim(TokenFilter.Trim filter) Add a trim filter.- Parameters:
- filter- a- TokenFilter.Trimvalue
- Since:
- Ant 1.6
 
 - 
addReplaceStringpublic void addReplaceString(TokenFilter.ReplaceString filter) Add a replacestring filter.- Parameters:
- filter- a- TokenFilter.ReplaceStringvalue
- Since:
- Ant 1.6
 
 - 
addIgnoreBlankpublic void addIgnoreBlank(TokenFilter.IgnoreBlank filter) Add an ignoreBlank filter.- Parameters:
- filter- a- TokenFilter.IgnoreBlankvalue
- Since:
- Ant 1.6
 
 - 
setRefidpublic 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:
- setRefidin class- DataType
- Parameters:
- r- the reference to which this instance is associated
- Throws:
- BuildException- if this instance already has been configured.
 
 - 
addpublic void add(ChainableReader filter) Add a chainfilter filter.- Parameters:
- filter- a- ChainableReadervalue
- Since:
- Ant 1.6
 
 - 
dieOnCircularReferenceprotected void dieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p) throws BuildExceptionDescription copied from class:DataTypeCheck 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.checkedis true and set it to true on exit.- Overrides:
- dieOnCircularReferencein class- DataType
- Parameters:
- stk- the stack of references to check.
- p- the project to use to dereference the references.
- Throws:
- BuildException- on error.
 
 
- 
 
-