Class JacocoExclusionReportExtension

java.lang.Object
com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension

public abstract class JacocoExclusionReportExtension extends Object
DSL extension for the JaCoCo exclusion report plugin.
 jacocoExclusionReport {
     annotationName = 'ExcludeFromJacocoGeneratedCodeCoverage'   // default
     sourceDirs.from(sourceSets.main.java.srcDirs)                // default
     reportDir  = layout.buildDirectory.dir('reports/jacoco-exclusions') // default
 }
 
  • Field Details

    • NAME

      public static final String NAME
      Extension DSL block name, i.e. the name used to register the extension with the project.
      See Also:
    • DEFAULT_ANNOTATION

      public static final String DEFAULT_ANNOTATION
      Default simple name of the annotation scanned for exclusions.
      See Also:
  • Constructor Details

    • JacocoExclusionReportExtension

      public JacocoExclusionReportExtension()
      For use by the Gradle-generated concrete subclass.
  • Method Details

    • getAnnotationName

      public abstract org.gradle.api.provider.Property<String> getAnnotationName()
      Simple (unqualified) name of the exclusion annotation.
      Returns:
      mutable property holding the annotation simple name
    • getSourceDirs

      public abstract org.gradle.api.file.ConfigurableFileCollection getSourceDirs()
      Java source directories to scan.
      Returns:
      mutable file collection of source directories
    • getReportDir

      public abstract org.gradle.api.file.DirectoryProperty getReportDir()
      Directory where the HTML and XML reports are written.
      Returns:
      mutable directory property for the report output location