Package net.sourceforge.pmd.ant

Class CPDTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

net.sourceforge.pmd.ant.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CPDTask.FormatAttribute

Field Summary

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

Constructors

Constructor	Description
CPDTask()

Method Summary

Modifier and Type	Method	Description
void	addFileset(org.apache.tools.ant.types.FileSet set)
void	execute()
void	setEncoding(String encoding)
void	setFailOnError(boolean failOnError)	Whether to fail the build if any recoverable errors occurred while processing the files.
void	setFormat(CPDTask.FormatAttribute formatAttribute)
void	setIgnoreAnnotations(boolean value)
void	setIgnoreIdentifiers(boolean value)
void	setIgnoreLiterals(boolean value)
void	setIgnoreUsings(boolean value)
void	setLanguage(String language)
void	setMinimumTokenCount(int minimumTokenCount)
void	setOutputFile(File outputFile)
void	setSkipBlocks(boolean skipBlocks)
void	setSkipBlocksPattern(String skipBlocksPattern)
void	setSkipDuplicateFiles(boolean skipDuplicateFiles)
void	setSkipLexicalErrors(boolean skipLexicalErrors)	Deprecated. Use setFailOnError(boolean) instead.

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Details

CPDTask

public CPDTask()

Method Details

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)

setSkipLexicalErrors

@Deprecated
public void setSkipLexicalErrors(boolean skipLexicalErrors)

Deprecated.

Use setFailOnError(boolean) instead.

setSkipDuplicateFiles

public void setSkipDuplicateFiles(boolean skipDuplicateFiles)

setOutputFile

public void setOutputFile(File outputFile)

setFormat

public void setFormat(CPDTask.FormatAttribute formatAttribute)

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