de.aaschmid.gradle.plugins.cpd

Interface CpdCsvFileReport

All Superinterfaces:

org.gradle.util.Configurable<org.gradle.api.reporting.Report>, org.gradle.api.reporting.ConfigurableReport, org.gradle.api.reporting.Report, org.gradle.api.reporting.SingleFileReport

All Known Implementing Classes:

CpdCsvFileReportImpl

public interface CpdCsvFileReport
extends org.gradle.api.reporting.SingleFileReport

The single file CSV report for code/paste (= duplication) detection.

See Also:

CpdPlugin

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report

org.gradle.api.reporting.Report.OutputType

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_INCLUDE_LINE_COUNT Default if line count column should be part of CSV.
static char	DEFAULT_SEPARATOR Default CSV separator.

Fields inherited from interface org.gradle.api.reporting.Report

NAMER

Method Summary

Modifier and Type	Method and Description
java.lang.Character	getSeparator()
boolean	isIncludeLineCount() Note: Property is originally named lineCountPerFile and meaning is inverted, see https://github.com/pmd/pmd/blob/master/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java#L63.
void	setIncludeLineCount(boolean includeLineCount)
void	setSeparator(java.lang.Character separator)

Methods inherited from interface org.gradle.api.reporting.SingleFileReport

getOutputLocation, getOutputType

Methods inherited from interface org.gradle.api.reporting.ConfigurableReport

setDestination, setDestination, setEnabled, setEnabled

Methods inherited from interface org.gradle.api.reporting.Report

getDestination, getDisplayName, getName, getRequired, isEnabled

Methods inherited from interface org.gradle.util.Configurable

configure

Field Detail

DEFAULT_SEPARATOR

static final char DEFAULT_SEPARATOR

Default CSV separator.

See Also:

Constant Field Values

DEFAULT_INCLUDE_LINE_COUNT

static final boolean DEFAULT_INCLUDE_LINE_COUNT

Default if line count column should be part of CSV.

See Also:

Constant Field Values

Method Detail

getSeparator

@Input
java.lang.Character getSeparator()

Returns:

the separator Character used to generate CSV report; defaults to DEFAULT_SEPARATOR.

setSeparator

void setSeparator(java.lang.Character separator)

Parameters:

separator - to be used when generating the CSV report; defaults to DEFAULT_SEPARATOR.

Throws:

org.gradle.api.InvalidUserDataException - iif supplied separator is null (char cannot be wrapped by Gradle interally, such that unboxable nulls must be checked in setter)

isIncludeLineCount

@Input
boolean isIncludeLineCount()

Note: Property is originally named lineCountPerFile and meaning is inverted, see https://github.com/pmd/pmd/blob/master/pmd-core/src/main/java/net/sourceforge/pmd/cpd/CSVRenderer.java#L63.

Returns:

if line count column should be included; defaults to DEFAULT_INCLUDE_LINE_COUNT.

setIncludeLineCount

void setIncludeLineCount(boolean includeLineCount)

Parameters:

includeLineCount - to be used when generating the CSV report; defaults to DEFAULT_INCLUDE_LINE_COUNT.