xjavadoc.ant
Class XJavadocFilter

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.types.DataType
          org.apache.tools.ant.types.selectors.BaseSelector
              org.apache.tools.ant.types.selectors.BaseExtendSelector
                  xjavadoc.ant.XJavadocFilter

All Implemented Interfaces:

java.lang.Cloneable, org.apache.tools.ant.types.Parameterizable, org.apache.tools.ant.types.selectors.ExtendFileSelector, org.apache.tools.ant.types.selectors.FileSelector

public class XJavadocFilter
extends org.apache.tools.ant.types.selectors.BaseExtendSelector

Custom file filter for Ant based on XJavadoc. Filters java sources according to some Java specific features.
Usage:

<copy todir="filtered-src">
   <fileset dir="src">
      <or>
         <custom classname="xjavadoc.XJavadocFilter" classpathref="lib.jars">
            <parameter name="implements" value="javax.ejb.EntityBean" />
         </custom>
         <custom classname="xjavadoc.XJavadocFilter" classpathref="lib.jars">
            <parameter name="implements" value="javax.ejb.SessionBean" />
         </custom>
      </or>
   </fileset>
</copy>

Valid parameters are:

implements

full qualified name of the class or interface to implement

contains-tag

javadoc tag to contain

Version:

$Revision: 1.6 $

Author:

Ludovic Claude

Field Summary

(package private) XJavaDoc

_xJavaDoc

Fields inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

parameters

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

XJavadocFilter()
Constructor for XJavadocFilter.

Method Summary

boolean

isSelected(java.io.File basedir, java.lang.String filename, java.io.File file)

Methods inherited from class org.apache.tools.ant.types.selectors.BaseExtendSelector

getParameters, setParameters

Methods inherited from class org.apache.tools.ant.types.selectors.BaseSelector

getError, setError, validate, verifySettings

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, tooManyAttributes, toString

Methods inherited from class org.apache.tools.ant.ProjectComponent

getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_xJavaDoc

XJavaDoc _xJavaDoc

Constructor Detail

XJavadocFilter

public XJavadocFilter()

Constructor for XJavadocFilter.

Method Detail

isSelected

public boolean isSelected(java.io.File basedir,
                          java.lang.String filename,
                          java.io.File file)
                   throws org.apache.tools.ant.BuildException

Specified by:

isSelected in interface org.apache.tools.ant.types.selectors.FileSelector

Specified by:

isSelected in class org.apache.tools.ant.types.selectors.BaseExtendSelector

Parameters:

basedir -

filename -

file -

Returns:

Throws:

org.apache.tools.ant.BuildException

See Also:

FileSelector.isSelected(File, String, File)