de.aaschmid.gradle.plugins.cpd

Interface CpdTextFileReport

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:

CpdTextFileReportImpl

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

The single file simple text 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 java.lang.String	DEFAULT_LINE_SEPARATOR Default line separator
static boolean	DEFAULT_TRIM_LEADING_COMMON_SOURCE_WHITESPACE Default setting if the leading common whitespace of a source code snipped should be trimmed or not.

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

NAMER

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLineSeparator()
boolean	getTrimLeadingCommonSourceWhitespaces()
void	setLineSeparator(java.lang.String lineSeparator)
void	setTrimLeadingCommonSourceWhitespaces(boolean trimLeadingCommonSourceWhitespaces)

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_LINE_SEPARATOR

static final java.lang.String DEFAULT_LINE_SEPARATOR

Default line separator

See Also:

Constant Field Values

DEFAULT_TRIM_LEADING_COMMON_SOURCE_WHITESPACE

static final boolean DEFAULT_TRIM_LEADING_COMMON_SOURCE_WHITESPACE

Default setting if the leading common whitespace of a source code snipped should be trimmed or not.

See Also:

Constant Field Values

Method Detail

getTrimLeadingCommonSourceWhitespaces

@Input
boolean getTrimLeadingCommonSourceWhitespaces()

Returns:

if the common leading whitespace of a source code snippet should be trimmed (= true) or not (= false); defaults to DEFAULT_TRIM_LEADING_COMMON_SOURCE_WHITESPACE.

setTrimLeadingCommonSourceWhitespaces

void setTrimLeadingCommonSourceWhitespaces(boolean trimLeadingCommonSourceWhitespaces)

Parameters:

trimLeadingCommonSourceWhitespaces - set to true if the leading common whitespaces of a single source code snippet should be trimmed, otherwise false; defaults to DEFAULT_TRIM_LEADING_COMMON_SOURCE_WHITESPACE.

getLineSeparator

@Input
java.lang.String getLineSeparator()

Returns:

the line separator String used to generate text report; defaults to DEFAULT_LINE_SEPARATOR.

setLineSeparator

void setLineSeparator(java.lang.String lineSeparator)

Parameters:

lineSeparator - to be used when generating the text report; defaults to DEFAULT_LINE_SEPARATOR.