Class 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.
    • Constructor Detail

      • AntFilterReader

        public AntFilterReader()
    • Method Detail

      • setClassName

        public void setClassName​(java.lang.String className)
        Set the className attribute.
        Parameters:
        className - a String value
      • getClassName

        public java.lang.String getClassName()
        Get the className attribute.
        Returns:
        a String value
      • addParam

        public void addParam​(Parameter param)
        Add a Parameter.
        Parameters:
        param - a Parameter value
      • 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:
        setRefid in class DataType
        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 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 class DataType
        Parameters:
        stk - the stack of references to check.
        p - the project to use to dereference the references.
        Throws:
        BuildException - on error.