Package de.aaschmid.gradle.plugins.cpd

Interface CpdReports

All Superinterfaces:
Collection<org.gradle.api.reporting.SingleFileReport>, org.gradle.util.Configurable<org.gradle.api.reporting.ReportContainer<org.gradle.api.reporting.SingleFileReport>>, org.gradle.api.DomainObjectCollection<org.gradle.api.reporting.SingleFileReport>, org.gradle.api.DomainObjectSet<org.gradle.api.reporting.SingleFileReport>, Iterable<org.gradle.api.reporting.SingleFileReport>, org.gradle.api.NamedDomainObjectCollection<org.gradle.api.reporting.SingleFileReport>, org.gradle.api.NamedDomainObjectSet<org.gradle.api.reporting.SingleFileReport>, org.gradle.api.reporting.ReportContainer<org.gradle.api.reporting.SingleFileReport>, Set<org.gradle.api.reporting.SingleFileReport>
All Known Implementing Classes:
CpdReportsImpl
public interface CpdReports extends org.gradle.api.reporting.ReportContainer<org.gradle.api.reporting.SingleFileReport>
The reporting configuration for the Cpd task.

One of

  • csv
  • text
  • vs
  • xml (default)

The reporting aspects of a Cpd task can be configured as such: 

 cpdCheck {
     reports {
         csv.required = false
         text {
             required = true
             outputLocation = file("${buildDir}/cpd.txt"
         }
     }
 }
See Also:

  • Nested Class Summary

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

    org.gradle.api.reporting.ReportContainer.ImmutableViolationException

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    csv(org.gradle.api.Action<CpdCsvFileReport> action)
    Configures the csv report.
    CpdCsvFileReport
    getCsv()
     
    CpdTextFileReport
    getText()
     
    org.gradle.api.reporting.SingleFileReport
    getVs()
     
    CpdXmlFileReport
    getXml()
     
    void
    text(org.gradle.api.Action<CpdTextFileReport> action)
    Configures the text report.
    void
    vs(org.gradle.api.Action<org.gradle.api.reporting.SingleFileReport> action)
    Configures the vs report.
    void
    xml(org.gradle.api.Action<CpdXmlFileReport> action)
    Configures the xml report.

    Methods inherited from interface java.util.Collection

    parallelStream, removeIf, stream, toArray

    Methods inherited from interface org.gradle.util.Configurable

    configure

    Methods inherited from interface org.gradle.api.DomainObjectCollection

    addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

    Methods inherited from interface java.lang.Iterable

    forEach

    Methods inherited from interface org.gradle.api.NamedDomainObjectCollection

    add, addAll, addRule, addRule, addRule, findByName, getAt, getByName, getByName, getByName, getCollectionSchema, named, named, named, named

    Methods inherited from interface org.gradle.api.NamedDomainObjectSet

    findAll, matching, matching, named, withType

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

    getAsMap, getEnabled, getEnabledReports, getNamer, getNames, getRules, isEmpty

    Methods inherited from interface java.util.Set

    add, addAll, clear, contains, containsAll, equals, hashCode, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

  • Method Details

    • getCsv

      CpdCsvFileReport getCsv()
      Returns:
      The CPD (single file) 'CSV' report

    • getText

      CpdTextFileReport getText()
      Returns:
      The CPD (single file) 'text' report

    • getVs

      org.gradle.api.reporting.SingleFileReport getVs()
      Returns:
      The CPD (single file) 'vs' report

    • getXml

      CpdXmlFileReport getXml()
      Returns:
      The CPD (single file) 'XML' report

    • csv

      void csv(org.gradle.api.Action<CpdCsvFileReport> action)
      Configures the csv report.
      Parameters:
      action - The Configuration closure/action.

    • text

      void text(org.gradle.api.Action<CpdTextFileReport> action)
      Configures the text report.
      Parameters:
      action - The Configuration closure/action.

    • vs

      void vs(org.gradle.api.Action<org.gradle.api.reporting.SingleFileReport> action)
      Configures the vs report.
      Parameters:
      action - The Configuration closure/action.

    • xml

      void xml(org.gradle.api.Action<CpdXmlFileReport> action)
      Configures the xml report.
      Parameters:
      action - The Configuration closure/action.