Package net.sourceforge.pmd.ant

Class CPDTask

  • All Implemented Interfaces:
    Cloneable
    public class CPDTask
extends org.apache.tools.ant.Task
    CPD Ant task. Setters of this class are interpreted by Ant as properties settable in the XML. This is therefore published API.

    Runs the CPD utility via ant. The ant task looks like this:

    
   <project name="CPDProject" default="main" basedir=".">
     <path id="pmd.classpath">
         <fileset dir="/home/joe/pmd-bin-VERSION/lib">
             <include name="*.jar"/>
         </fileset>
     </path>
     <taskdef name="cpd" classname="net.sourceforge.pmd.ant.CPDTask" classpathref="pmd.classpath" />

     <target name="main">
       <cpd encoding="UTF-16LE" language="java" ignoreIdentifiers="true"
            ignoreLiterals="true" ignoreAnnotations="true" minimumTokenCount="100"
            outputFile="c:\cpdrun.txt">
         <fileset dir="/path/to/my/src">
           <include name="*.java"/>
         </fileset>
       </cpd>
     </target>
   </project>

    Required: minimumTokenCount, outputFile, and at least one file

    • Constructor Detail

      • CPDTask

        public CPDTask()

    • Method Detail

      • execute

        public void execute()
             throws org.apache.tools.ant.BuildException
        Overrides:
        execute in class org.apache.tools.ant.Task
        Throws:
        org.apache.tools.ant.BuildException

      • addFileset

        public void addFileset​(org.apache.tools.ant.types.FileSet set)

      • setMinimumTokenCount

        public void setMinimumTokenCount​(int minimumTokenCount)

      • setIgnoreLiterals

        public void setIgnoreLiterals​(boolean value)

      • setIgnoreIdentifiers

        public void setIgnoreIdentifiers​(boolean value)

      • setIgnoreAnnotations

        public void setIgnoreAnnotations​(boolean value)

      • setIgnoreUsings

        public void setIgnoreUsings​(boolean value)

      • setSkipDuplicateFiles

        public void setSkipDuplicateFiles​(boolean skipDuplicateFiles)

      • setOutputFile

        public void setOutputFile​(File outputFile)

      • setLanguage

        public void setLanguage​(String language)

      • setEncoding

        public void setEncoding​(String encoding)

      • setSkipBlocks

        public void setSkipBlocks​(boolean skipBlocks)

      • setSkipBlocksPattern

        public void setSkipBlocksPattern​(String skipBlocksPattern)

      • setFailOnError

        public void setFailOnError​(boolean failOnError)
        Whether to fail the build if any recoverable errors occurred while processing the files.
        Since:
        7.3.0