Package org.apache.tools.ant.types
Class AntFilterReader
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.AntFilterReader
- All Implemented Interfaces:
- Cloneable
An AntFilterReader is a wrapper class that encloses the classname
 and configuration of a Configurable FilterReader.
- 
Field SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a Parameter.Set the classpath to load the FilterReader through (nested element).protected voiddieOnCircularReference(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).Get the className attribute.Get the classpath.The parameters for this filter.voidsetClassName(String className) Set the className attribute.voidsetClasspath(Path classpath) Set the classpath to load the FilterReader through (attribute).voidSet the classpath to load the FilterReader through via reference (attribute).voidMakes this instance in effect a reference to another AntFilterReader 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, toStringMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
- 
Constructor Details- 
AntFilterReaderpublic AntFilterReader()
 
- 
- 
Method Details- 
setClassNameSet the className attribute.- Parameters:
- className- a- Stringvalue
 
- 
getClassNameGet the className attribute.- Returns:
- a Stringvalue
 
- 
addParamAdd a Parameter.- Parameters:
- param- a- Parametervalue
 
- 
setClasspathSet the classpath to load the FilterReader through (attribute).- Parameters:
- classpath- a classpath
 
- 
createClasspathSet the classpath to load the FilterReader through (nested element).- Returns:
- a classpath to be configured
 
- 
getClasspathGet the classpath.- Returns:
- the classpath
 
- 
setClasspathRefSet the classpath to load the FilterReader through via reference (attribute).- Parameters:
- r- a reference to a classpath
 
- 
getParamsThe parameters for this filter.- Returns:
- a Parameter[]value
 
- 
setRefidMakes this instance in effect a reference to another AntFilterReader 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.
 
- 
dieOnCircularReferenceDescription 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.
 
 
-