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:
java.lang.Cloneable
public final class AntFilterReader extends DataType
An AntFilterReader is a wrapper class that encloses the classname and configuration of a Configurable FilterReader.
-
-
Field Summary
-
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Constructor Description AntFilterReader()
-
Method Summary
Modifier and Type Method Description voidaddParam(Parameter param)Add a Parameter.PathcreateClasspath()Set the classpath to load the FilterReader through (nested element).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.lang.StringgetClassName()Get the className attribute.PathgetClasspath()Get the classpath.Parameter[]getParams()The parameters for this filter.voidsetClassName(java.lang.String className)Set the className attribute.voidsetClasspath(Path classpath)Set the classpath to load the FilterReader through (attribute).voidsetClasspathRef(Reference r)Set the classpath to load the FilterReader through via reference (attribute).voidsetRefid(Reference r)Makes this instance in effect a reference to another AntFilterReader 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
-
setClassName
public void setClassName(java.lang.String className)
Set the className attribute.- Parameters:
className- aStringvalue
-
getClassName
public java.lang.String getClassName()
Get the className attribute.- Returns:
- a
Stringvalue
-
addParam
public void addParam(Parameter param)
Add a Parameter.- Parameters:
param- aParametervalue
-
setClasspath
public void setClasspath(Path classpath)
Set the classpath to load the FilterReader through (attribute).- Parameters:
classpath- a classpath
-
createClasspath
public Path createClasspath()
Set the classpath to load the FilterReader through (nested element).- Returns:
- a classpath to be configured
-
getClasspath
public Path getClasspath()
Get the classpath.- Returns:
- the classpath
-
setClasspathRef
public void setClasspathRef(Reference r)
Set the classpath to load the FilterReader through via reference (attribute).- Parameters:
r- a reference to a classpath
-
getParams
public Parameter[] getParams()
The parameters for this filter.- Returns:
- a
Parameter[]value
-
setRefid
public void setRefid(Reference r) throws BuildException
Makes 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 classDataType- Parameters:
r- the reference to which this instance is associated- Throws:
BuildException- if this instance already has been configured.
-
dieOnCircularReference
protected 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 classDataType- Parameters:
stk- the stack of references to check.p- the project to use to dereference the references.- Throws:
BuildException- on error.
-
-