Cpd (gradle-cpd-plugin 3.3 API)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - org.gradle.api.internal.ConventionTask
    - - org.gradle.api.tasks.SourceTask
      - de.aaschmid.gradle.plugins.cpd.Cpd

All Implemented Interfaces:: java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.reporting.Reporting<CpdReports>, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.api.tasks.VerificationTask, org.gradle.util.Configurable<org.gradle.api.Task>

@CacheableTask
public class Cpd
extends org.gradle.api.tasks.SourceTask
implements org.gradle.api.tasks.VerificationTask, org.gradle.api.reporting.Reporting<CpdReports>

Runs static code/paste (= duplication) detection on supplied source code files and generates a report of duplications found.

Sample:

 apply plugin: 'cpd'

 task cpd(type: Cpd, description: 'Copy/Paste detection for all Ruby scripts') {

     // change language of cpd to Ruby
     language = 'ruby'

     // set minimum token count causing a duplication warning
     minimumTokenCount = 10

     // enable CSV reports and customize outputLocation, disable xml report
     reports {
         csv {
             required = true
             outputLocation = file("${buildDir}/cpd.csv")
         }
         xml.required = false
     }

     // explicitly include all Ruby files and exclude tests
     include '**.rb'
     exclude '**Test*'

     // set source for running duplication check on
     source = files('src/ruby')
 }

See Also:: CpdPlugin

Nested Class Summary
- Nested classes/interfaces inherited from interface org.gradle.api.Task
  org.gradle.api.Task.Namer

Field Summary
- Fields inherited from interface org.gradle.api.Task
  TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors
Constructor and Description
`Cpd(org.gradle.api.model.ObjectFactory objectFactory, org.gradle.api.provider.ProviderFactory providerFactory, org.gradle.workers.WorkerExecutor workerExecutor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getEncoding()` The character set encoding (e.g., UTF-8) to use when reading the source code files but also when producing the report; defaults to `CpdExtension.getEncoding()`.
`boolean`	`getIgnoreAnnotations()` Ignore annotations because more and more modern frameworks use annotations on classes and methods which can be very redundant and causes false positives.
`boolean`	`getIgnoreFailures()` Whether or not to allow the build to continue if there are warnings.
`boolean`	`getIgnoreIdentifiers()` Option if CPD should ignore identifiers differences, i.e. variable names, methods names, and so forth, when evaluating a duplicate block.
`boolean`	`getIgnoreLiterals()` Option if CPD should ignore literal value differences when evaluating a duplicate block.
`java.lang.String`	`getLanguage()` Flag to select the appropriate language.
`java.lang.Integer`	`getMinimumTokenCount()` A positive integer indicating the minimum token count to trigger a CPD match; defaults to `CpdExtension.getMinimumTokenCount()`.
`org.gradle.api.file.FileCollection`	`getPmdClasspath()` The classpath containing the PMD library which contains the CPD library to be used.
`CpdReports`	`getReports()`
`boolean`	`getSkipBlocks()` Enables or disables skipping of blocks configured by `skipBlocksPattern`.
`java.lang.String`	`getSkipBlocksPattern()` Configures the pattern, to find the blocks to skip if enabled using `skipBlocks`.
`boolean`	`getSkipDuplicateFiles()` Ignore multiple copies of files of the same name and length in comparison.
`boolean`	`getSkipLexicalErrors()` Skip files which cannot be tokenized due to invalid characters instead of aborting CPD.
`org.gradle.api.file.FileTree`	`getSource()`
`CpdReports`	`reports(org.gradle.api.Action<? super CpdReports> action)`
`CpdReports`	`reports(groovy.lang.Closure closure)`
`void`	`run()`
`void`	`setEncoding(java.lang.String encoding)`
`void`	`setIgnoreAnnotations(boolean ignoreAnnotations)`
`void`	`setIgnoreFailures(boolean ignoreFailures)`
`void`	`setIgnoreIdentifiers(boolean ignoreIdentifiers)`
`void`	`setIgnoreLiterals(boolean ignoreLiterals)`
`void`	`setLanguage(java.lang.String language)`
`void`	`setMinimumTokenCount(java.lang.Integer minimumTokenCount)`
`void`	`setPmdClasspath(org.gradle.api.file.FileCollection pmdClasspath)`
`void`	`setSkipBlocks(boolean skipBlocks)`
`void`	`setSkipBlocksPattern(java.lang.String skipBlocksPattern)`
`void`	`setSkipDuplicateFiles(boolean skipDuplicateFiles)`
`void`	`setSkipLexicalErrors(boolean skipLexicalErrors)`

Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source

Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.DefaultTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, replaceLogger, setImpliesSubProjects

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task
getConvention

- Constructor Detail
  - Cpd
```
@Inject
public Cpd(org.gradle.api.model.ObjectFactory objectFactory,
                   org.gradle.api.provider.ProviderFactory providerFactory,
                   org.gradle.workers.WorkerExecutor workerExecutor)
```
- Method Detail
  - run
```
public void run()
```
  - getSource
```
@InputFiles
 @SkipWhenEmpty
 @PathSensitive(value=RELATIVE)
public org.gradle.api.file.FileTree getSource()
```
    Overrides:
    
    getSource in class org.gradle.api.tasks.SourceTask
  - reports
```
public CpdReports reports(@DelegatesTo(value=CpdReports.class,strategy=1)
                          groovy.lang.Closure closure)
```
    Specified by:
    
    reports in interface org.gradle.api.reporting.Reporting<CpdReports>
  - getReports
```
public CpdReports getReports()
```
    Specified by:
    
    getReports in interface org.gradle.api.reporting.Reporting<CpdReports>
  - reports
```
public CpdReports reports(org.gradle.api.Action<? super CpdReports> action)
```
    Specified by:
    
    reports in interface org.gradle.api.reporting.Reporting<CpdReports>
  - getEncoding
```
@Input
 @Optional
public java.lang.String getEncoding()
```
    The character set encoding (e.g., UTF-8) to use when reading the source code files but also when producing the report; defaults to CpdExtension.getEncoding().
    Example: encoding = UTF-8
    
    Returns:
    
    the charset encoding
  - setEncoding
```
public void setEncoding(java.lang.String encoding)
```
  - getIgnoreAnnotations
```
@Input
public boolean getIgnoreAnnotations()
```
    Ignore annotations because more and more modern frameworks use annotations on classes and methods which can be very redundant and causes false positives.
    Example: ignoreAnnotations = true
    
    Returns:
    
    if annotations should be ignored
  - setIgnoreAnnotations
```
public void setIgnoreAnnotations(boolean ignoreAnnotations)
```
  - getIgnoreFailures
```
@Input
public boolean getIgnoreFailures()
```
    Whether or not to allow the build to continue if there are warnings.
    Example: ignoreFailures = true
    
    Specified by:
    
    getIgnoreFailures in interface org.gradle.api.tasks.VerificationTask
  - setIgnoreFailures
```
public void setIgnoreFailures(boolean ignoreFailures)
```
    Specified by:
    
    setIgnoreFailures in interface org.gradle.api.tasks.VerificationTask
  - getIgnoreIdentifiers
```
@Input
public boolean getIgnoreIdentifiers()
```
    Option if CPD should ignore identifiers differences, i.e. variable names, methods names, and so forth, when evaluating a duplicate block.
    Example: ignoreIdentifiers = true
    
    Returns:
    
    whether identifiers should be ignored
  - setIgnoreIdentifiers
```
public void setIgnoreIdentifiers(boolean ignoreIdentifiers)
```
  - getIgnoreLiterals
```
@Input
public boolean getIgnoreLiterals()
```
    Option if CPD should ignore literal value differences when evaluating a duplicate block. This means e.g. that foo=42; and foo=43; will be seen as equivalent.
    Example: ignoreLiterals = true
    
    Returns:
    
    whether literals should be ignored
  - setIgnoreLiterals
```
public void setIgnoreLiterals(boolean ignoreLiterals)
```
  - getLanguage
```
@Input
public java.lang.String getLanguage()
```
    Flag to select the appropriate language.
    Example: language = 'java'
    
    Returns:
    
    used language
  - setLanguage
```
public void setLanguage(java.lang.String language)
```
  - getMinimumTokenCount
```
@Input
public java.lang.Integer getMinimumTokenCount()
```
    A positive integer indicating the minimum token count to trigger a CPD match; defaults to CpdExtension.getMinimumTokenCount().
    Example: minimumTokenCount = 25
    
    Returns:
    
    the minimum token cound
  - setMinimumTokenCount
```
public void setMinimumTokenCount(java.lang.Integer minimumTokenCount)
```
  - getPmdClasspath
```
@Classpath
public org.gradle.api.file.FileCollection getPmdClasspath()
```
    The classpath containing the PMD library which contains the CPD library to be used.
    
    Returns:
    
    CPD libraries classpath
  - setPmdClasspath
```
public void setPmdClasspath(org.gradle.api.file.FileCollection pmdClasspath)
```
  - getSkipDuplicateFiles
```
@Input
public boolean getSkipDuplicateFiles()
```
    Ignore multiple copies of files of the same name and length in comparison.
    Example: skipDuplicateFiles = true
    
    Returns:
    
    whether duplicate files should be skipped
  - setSkipDuplicateFiles
```
public void setSkipDuplicateFiles(boolean skipDuplicateFiles)
```
  - getSkipLexicalErrors
```
@Input
public boolean getSkipLexicalErrors()
```
    Skip files which cannot be tokenized due to invalid characters instead of aborting CPD.
    Example: skipLexicalErrors = true
    
    Returns:
    
    whether lexical errors should be skipped
  - setSkipLexicalErrors
```
public void setSkipLexicalErrors(boolean skipLexicalErrors)
```
  - getSkipBlocks
```
@Input
public boolean getSkipBlocks()
```
    Enables or disables skipping of blocks configured by skipBlocksPattern.
    Example: skipBlocks = false
    
    Returns:
    
    whether blocks should be skipped by a given pattern
    
    See Also:
    
    skipBlocksPattern
  - setSkipBlocks
```
public void setSkipBlocks(boolean skipBlocks)
```
  - getSkipBlocksPattern
```
@Input
public java.lang.String getSkipBlocksPattern()
```
    Configures the pattern, to find the blocks to skip if enabled using skipBlocks. It is a String property and contains of two parts, separated by '|'. The first part is the start pattern, the second part is the ending pattern.
    Example: skipBlocksPattern = '#include <|>'
    
    Returns:
    
    the pattern used to skip blocks
    
    See Also:
    
    skipBlocks
  - setSkipBlocksPattern
```
public void setSkipBlocksPattern(java.lang.String skipBlocksPattern)
```

Class Cpd

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Field Summary

Fields inherited from interface org.gradle.api.Task

Constructor Summary

Method Summary

Methods inherited from class org.gradle.api.tasks.SourceTask

Methods inherited from class org.gradle.api.internal.ConventionTask

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class org.gradle.api.internal.AbstractTask

Methods inherited from class java.lang.Object

Methods inherited from interface org.gradle.api.Task

Constructor Detail

Cpd

Method Detail

run

getSource

reports

getReports

reports

getEncoding

setEncoding

getIgnoreAnnotations

setIgnoreAnnotations

getIgnoreFailures

setIgnoreFailures

getIgnoreIdentifiers

setIgnoreIdentifiers

getIgnoreLiterals

setIgnoreLiterals

getLanguage

setLanguage

getMinimumTokenCount

setMinimumTokenCount

getPmdClasspath

setPmdClasspath

getSkipDuplicateFiles

setSkipDuplicateFiles

getSkipLexicalErrors

setSkipLexicalErrors

getSkipBlocks

setSkipBlocks

getSkipBlocksPattern

setSkipBlocksPattern