Package com.arc_e_tect.gradle.jacoco

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
     includeConfiguredExclusions = true                            // default
     includeGeneratedAnnotationExclusions = false                  // default (opt-in)
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_ANNOTATION
    Default simple name of the annotation scanned for exclusions.
    static final String
    NAME
    Extension DSL block name, i.e.

  • Constructor Summary

    Constructors
    Constructor
    Description
    JacocoExclusionReportExtension()
    For use by the Gradle-generated concrete subclass.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<String>
    getAnnotationName()
    Simple (unqualified) name of the exclusion annotation.
    abstract org.gradle.api.provider.Property<Boolean>
    getIncludeConfiguredExclusions()
    Whether exclusions configured through JaCoCo task DSL should be reported in a separate report file in addition to annotation-based exclusions.
    abstract org.gradle.api.provider.Property<Boolean>
    getIncludeGeneratedAnnotationExclusions()
    Whether to additionally scan compiled classes for members that JaCoCo automatically excludes because they carry an annotation whose simple name is Generated but that was not written by hand — e.g.
    abstract org.gradle.api.file.DirectoryProperty
    getReportDir()
    Directory where the HTML and XML reports are written.
    abstract org.gradle.api.file.ConfigurableFileCollection
    getSourceDirs()
    Java source directories to scan.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • 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

    • getIncludeConfiguredExclusions

      public abstract org.gradle.api.provider.Property<Boolean> getIncludeConfiguredExclusions()
      Whether exclusions configured through JaCoCo task DSL should be reported in a separate report file in addition to annotation-based exclusions.
      Returns:
      mutable flag controlling JaCoCo DSL exclusion reporting

    • getIncludeGeneratedAnnotationExclusions

      public abstract org.gradle.api.provider.Property<Boolean> getIncludeGeneratedAnnotationExclusions()
      Whether to additionally scan compiled classes for members that JaCoCo automatically excludes because they carry an annotation whose simple name is Generated but that was not written by hand — e.g. Lombok's @lombok.Generated, which Lombok stamps onto every getter, setter, constructor, and other member it synthesises. These members never appear in the .java source, so they can only be found by inspecting the compiled .class files.

      Disabled by default: it only takes effect when set to true explicitly in the jacocoExclusionReport DSL block.

      Returns:
      mutable flag controlling tool-generated @Generated exclusion reporting