org.myire.quill.cpd

Class CpdTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.SourceTask

org.myire.quill.cpd.CpdTask

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.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>, ReportingEntity<CpdReports>

public class CpdTask
extends org.gradle.api.tasks.SourceTask
implements ReportingEntity<CpdReports>

Task for performing copy-paste detection using the CPD tool.

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
CpdTask()

Method Summary

Modifier and Type	Method and Description
org.gradle.api.file.FileCollection	getCpdClasspath() Get the classpath containing the CPD classes used by the task.
java.lang.String	getEncoding() Get the encoding used by CPD to read the source files and to produce the report.
java.lang.String	getLanguage() Get the language of the source files to analyze, e.g.
int	getMinimumTokenCount() The minimum duplicate size to be reported.
CpdReports	getReports() Get the reports produced by this task.
java.lang.String	getSkipBlocksPattern() Specifies the pattern to find the blocks to skip when skipBlocks is true.
org.gradle.api.file.FileTree	getSource()
java.lang.String	getToolVersion() Get the version of CPD to use.
boolean	isIgnoreAnnotations() If true, annotations will be ignored.
boolean	isIgnoreIdentifiers() If true, differences in identifiers (like variable names or methods names) will be ignored in the same way as literals in isIgnoreLiterals().
boolean	isIgnoreLiterals() If true, CPD ignores literal value differences when evaluating a duplicate block.
boolean	isIgnoreUsings() If true, using directives in C# will be ignored when comparing text.
boolean	isSkipBlocks() If true, skipping of blocks is enabled with the patterns specified in the skipBlocksPattern property.
boolean	isSkipDuplicateFiles() If true, CPD will ignore multiple copies of files with the same name and length.
boolean	isSkipLexicalErrors() If true, CPD will skip files which can't be tokenized due to invalid characters instead of aborting the analysis.
CpdReports	reports(org.gradle.api.Action<? super CpdReports> pAction) Configure this task's reports.
CpdReports	reports(groovy.lang.Closure pClosure) Configure this task's reports.
void	run() Perform copy-paste detection on the sources and produces the enabled report(s).
void	setCpdClasspath(org.gradle.api.file.FileCollection pCpdClasspath)
void	setEncoding(java.lang.String pEncoding)
void	setIgnoreAnnotations(boolean pIgnoreAnnotations)
void	setIgnoreIdentifiers(boolean pIgnoreIdentifiers)
void	setIgnoreLiterals(boolean pIgnoreLiterals)
void	setIgnoreUsings(boolean pIgnoreUsings)
void	setLanguage(java.lang.String pLanguage)
void	setMinimumTokenCount(int pMinimumTokenCount)
void	setSkipBlocks(boolean pSkipBlocks)
void	setSkipBlocksPattern(java.lang.String pSkipBlocksPattern)
void	setSkipDuplicateFiles(boolean pSkipDuplicateFiles)
void	setSkipLexicalErrors(boolean pSkipLexicalErrors)
void	setToolVersion(java.lang.String pToolVersion)

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.internal.AbstractTask

appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getRequiredServices, getServices, getSharedResources, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString, usesService

Methods inherited from class java.lang.Object

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

Constructor Detail

CpdTask

public CpdTask()

Method Detail

getSource

@InputFiles
 @SkipWhenEmpty
public org.gradle.api.file.FileTree getSource()

Overrides:

getSource in class org.gradle.api.tasks.SourceTask

getToolVersion

@Input
public java.lang.String getToolVersion()

Get the version of CPD to use. Default is the version specified in PmdExtension.toolVersion, or, if that extension isn't available, version "6.16.0".

Returns:

The CPD version string.

setToolVersion

public void setToolVersion(java.lang.String pToolVersion)

getCpdClasspath

@InputFiles
public org.gradle.api.file.FileCollection getCpdClasspath()

Get the classpath containing the CPD classes used by the task. The plugin sets this property to its default value, which is the cpd configuration.

Returns:

The CPD classpath.

setCpdClasspath

public void setCpdClasspath(org.gradle.api.file.FileCollection pCpdClasspath)

getReports

public CpdReports getReports()

Get the reports produced by this task.

Specified by:

getReports in interface ReportingEntity<CpdReports>

Returns:

The reports.

reports

public CpdReports reports(groovy.lang.Closure pClosure)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<CpdReports>

Parameters:

pClosure - A closure that configures the reports.

Returns:

This task's reports.

reports

public CpdReports reports(org.gradle.api.Action<? super CpdReports> pAction)

Configure this task's reports.

Specified by:

reports in interface ReportingEntity<CpdReports>

Parameters:

pAction - An action that configures the reports.

Returns:

This task's reports.

getEncoding

@Input
 @Optional
public java.lang.String getEncoding()

Get the encoding used by CPD to read the source files and to produce the report. The platform's default encoding will be used if this property isn't specified.

Returns:

The source file encoding.

setEncoding

public void setEncoding(java.lang.String pEncoding)

getLanguage

@Input
 @Optional
public java.lang.String getLanguage()

Get the language of the source files to analyze, e.g. "cpp", "java", "php", "ruby", or "ecmascript". See the CPD documentation for the list of languages supported by the different versions of CPD. The default is "java".

Returns:

The language.

setLanguage

public void setLanguage(java.lang.String pLanguage)

getMinimumTokenCount

@Input
public int getMinimumTokenCount()

The minimum duplicate size to be reported. The default is 100.

Returns:

The minimum duplicate size.

setMinimumTokenCount

public void setMinimumTokenCount(int pMinimumTokenCount)

isIgnoreLiterals

@Input
public boolean isIgnoreLiterals()

If true, CPD ignores literal value differences when evaluating a duplicate block. This means that foo=42; and foo=43; will be seen as equivalent. Default is false.

Returns:

True if differences in literals should be ignored, false if they should count.

setIgnoreLiterals

public void setIgnoreLiterals(boolean pIgnoreLiterals)

isIgnoreIdentifiers

@Input
public boolean isIgnoreIdentifiers()

If true, differences in identifiers (like variable names or methods names) will be ignored in the same way as literals in isIgnoreLiterals(). Default is false.

Returns:

True if differences in identifiers should be ignored, false if they should count.

setIgnoreIdentifiers

public void setIgnoreIdentifiers(boolean pIgnoreIdentifiers)

isIgnoreAnnotations

@Input
public boolean isIgnoreAnnotations()

If true, annotations will be ignored. This property can be useful when analyzing code based one some frameworks where annotations become very repetitive. Default is false.

Returns:

True if annotations should be ignored, false if they should count.

setIgnoreAnnotations

public void setIgnoreAnnotations(boolean pIgnoreAnnotations)

isSkipDuplicateFiles

@Input
public boolean isSkipDuplicateFiles()

If true, CPD will ignore multiple copies of files with the same name and length. Default is false.

Returns:

True if duplicate files should be skipped, false if not.

setSkipDuplicateFiles

public void setSkipDuplicateFiles(boolean pSkipDuplicateFiles)

isSkipLexicalErrors

@Input
public boolean isSkipLexicalErrors()

If true, CPD will skip files which can't be tokenized due to invalid characters instead of aborting the analysis. Default is false.

Returns:

True if files with lexical errors should be skipped, false if not.

setSkipLexicalErrors

public void setSkipLexicalErrors(boolean pSkipLexicalErrors)

isSkipBlocks

@Input
public boolean isSkipBlocks()

If true, skipping of blocks is enabled with the patterns specified in the skipBlocksPattern property. Default is false.

Returns:

True if blocks matching skipBlocksPattern should be skipped, false if not.

setSkipBlocks

public void setSkipBlocks(boolean pSkipBlocks)

getSkipBlocksPattern

@Input
 @Optional
public java.lang.String getSkipBlocksPattern()

Specifies the pattern to find the blocks to skip when skipBlocks is true. The string value contains two parts, separated by a vertical line ('|'). The first part is the start pattern, the second part is the end pattern. The default value is "#if 0|#endif".

Returns:

The skip blocks pattern.

setSkipBlocksPattern

public void setSkipBlocksPattern(java.lang.String pSkipBlocksPattern)

isIgnoreUsings

@Input
public boolean isIgnoreUsings()

If true, using directives in C# will be ignored when comparing text. Default is false.

Returns:

True if using directives should be ignored, false if they should count.

setIgnoreUsings

public void setIgnoreUsings(boolean pIgnoreUsings)

run

public void run()

Perform copy-paste detection on the sources and produces the enabled report(s).