org.apache.tools.ant.types

Class AntFilterReader

public final class AntFilterReader extends DataType implements Cloneable

An AntFilterReader is a wrapper class that encloses the classname and configuration of a Configurable FilterReader.

Method Summary
void	addParam(Parameter param) Add a Parameter.
Path	createClasspath() Set the classpath to load the FilterReader through (nested element).
String	getClassName() Get the className attribute.
Path	getClasspath() Get the classpath.
Parameter[]	getParams() The parameters for this filter.
void	setClassName(String className) Set the className attribute.
void	setClasspath(Path classpath) Set the classpath to load the FilterReader through (attribute).
void	setClasspathRef(Reference r) Set the classpath to load the FilterReader through via reference (attribute).
void	setRefid(Reference r) Makes this instance in effect a reference to another AntFilterReader instance.

Method Detail

addParam

public void addParam(Parameter param)

Add a Parameter.

Parameters: param a Parameter value

createClasspath

public Path createClasspath()

Set the classpath to load the FilterReader through (nested element).

Returns: a classpath to be configured

getClassName

public String getClassName()

Get the className attribute.

Returns: a String value

getClasspath

public Path getClasspath()

Get the classpath.

Returns: the classpath

getParams

public Parameter[] getParams()

The parameters for this filter.

Returns: a Parameter[] value

setClassName

public void setClassName(String className)

Set the className attribute.

Parameters: className a String value

setClasspath

public void setClasspath(Path classpath)

Set the classpath to load the FilterReader through (attribute).

Parameters: classpath a 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

setRefid

public void setRefid(Reference r)

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.

Parameters: r the reference to which this instance is associated

Throws: BuildException if this instance already has been configured.