Package 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:

  • 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
    Description
    static final boolean
    DEFAULT_INCLUDE_LINE_COUNT
    Default if line count column should be part of CSV.
    static final char
    DEFAULT_SEPARATOR
    Default CSV separator.

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

    NAMER

  • Method Summary

    Modifier and Type
    Method
    Description
    Character
    getSeparator()
     
    boolean
    isIncludeLineCount()
    Note: Property is originally named lineCountPerFile and meaning is inverted, see ....
    void
    setIncludeLineCount(boolean includeLineCount)
     
    void
    setSeparator(Character separator)
     

    Methods inherited from interface org.gradle.util.Configurable

    configure

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

    getDisplayName, getName, getRequired

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

    getOutputLocation, getOutputType

  • Field Details

    • DEFAULT_SEPARATOR

      static final char DEFAULT_SEPARATOR
      Default CSV separator.
      See Also:

    • DEFAULT_INCLUDE_LINE_COUNT

      static final boolean DEFAULT_INCLUDE_LINE_COUNT
      Default if line count column should be part of CSV.
      See Also:

  • Method Details

    • getSeparator

      @Input Character getSeparator()
      Returns:
      the separator Character used to generate CSV report; defaults to DEFAULT_SEPARATOR.

    • setSeparator

      void setSeparator(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 internally, such that unboxable nulls must be checked in setter)

    • isIncludeLineCount

      @Input boolean isIncludeLineCount()
      Note: Property is originally named lineCountPerFile and meaning is inverted, see ....
      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.