Index (jacoco-exclusion-report 0.2.1 API)

A C D E F G H J L M N S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values

A

AnnotationScanner - Class in com.arc_e_tect.gradle.jacoco.scan: Parses a single Java source file and collects every element that carries the configured exclusion annotation.
AnnotationScanner(String) - Constructor for class com.arc_e_tect.gradle.jacoco.scan.AnnotationScanner: Creates a scanner that looks for the given annotation.
apply(Project) - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportPlugin

C

CLASS - Enum constant in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Annotation is placed on a class or interface declaration.
com.arc_e_tect.gradle.jacoco - package com.arc_e_tect.gradle.jacoco
com.arc_e_tect.gradle.jacoco.model - package com.arc_e_tect.gradle.jacoco.model
com.arc_e_tect.gradle.jacoco.report - package com.arc_e_tect.gradle.jacoco.report
com.arc_e_tect.gradle.jacoco.scan - package com.arc_e_tect.gradle.jacoco.scan
CONSTRUCTOR - Enum constant in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Annotation is placed on a constructor declaration.

D

DEFAULT_ANNOTATION - Static variable in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension: Default simple name of the annotation scanned for exclusions.
Defaults - Search tag in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportPlugin: Section
displayName() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Display name used as the test-case name attribute in XML.

E

ExcludedElement - Class in com.arc_e_tect.gradle.jacoco.model: Represents a single Java element that carries the exclusion annotation.
ExcludedElement(ExcludedElement.ElementType, String, String, String, int, String) - Constructor for class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Backward-compatible constructor without justification (defaults to empty string).
ExcludedElement(ExcludedElement.ElementType, String, String, String, int, String, String) - Constructor for class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Full constructor including justification.
ExcludedElement.ElementType - Enum Class in com.arc_e_tect.gradle.jacoco.model: Classifies the kind of Java element that carries the exclusion annotation.

F

FIELD - Enum constant in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Annotation is placed on a field declaration.

G

generate() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportTask: Scans all configured source files for the exclusion annotation and writes the HTML and XML reports to JacocoExclusionReportTask.getReportDir().
getAnnotationName() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension: Simple (unqualified) name of the exclusion annotation.
getAnnotationName() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportTask: Simple (unqualified) name of the annotation to search for.
getClassName() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the simple or nested class name of the declaring class.
getFqcn() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Fully-qualified class name.
getJustification() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the human-readable justification for the exclusion.
getLineNumber() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the source line number where the exclusion annotation appears.
getMember() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the member signature.
getPackageName() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the package name of the declaring class.
getReportDir() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension: Directory where the HTML and XML reports are written.
getReportDir() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportTask: Directory to write the HTML and XML reports into.
getSourceDirs() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension: Java source directories to scan.
getSourceFile() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the simple file name of the source file.
getSourceFiles() - Method in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportTask: Java source files to scan.
getType() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement: Returns the element type.

H

HtmlReportWriter - Class in com.arc_e_tect.gradle.jacoco.report: Writes an HTML report styled after Gradle's built-in test report.
HtmlReportWriter() - Constructor for class com.arc_e_tect.gradle.jacoco.report.HtmlReportWriter: Creates a new HtmlReportWriter.

J

JacocoExclusionReportExtension - Class in com.arc_e_tect.gradle.jacoco: DSL extension for the JaCoCo exclusion report plugin.
JacocoExclusionReportExtension() - Constructor for class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension: For use by the Gradle-generated concrete subclass.
JacocoExclusionReportPlugin - Class in com.arc_e_tect.gradle.jacoco: Gradle plugin that registers the jacocoExclusionReport task and wires it into the standard verification lifecycle.
JacocoExclusionReportPlugin() - Constructor for class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportPlugin: Creates a new plugin instance.
JacocoExclusionReportTask - Class in com.arc_e_tect.gradle.jacoco: Gradle task that scans Java source files for the exclusion annotation and writes HTML and XML reports to the configured output directory.
JacocoExclusionReportTask() - Constructor for class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportTask: Creates the task.

L

label() - Method in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Human-readable label used in reports.
Lifecycle - Search tag in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportPlugin: Section

M

METHOD - Enum constant in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Annotation is placed on a method declaration.

N

NAME - Static variable in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportExtension: Extension DSL block name, i.e.

S

scan(File) - Method in class com.arc_e_tect.gradle.jacoco.scan.AnnotationScanner: Scans one .java source file and returns every annotated element.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportPlugin: Name of the Gradle task registered by this plugin.
toString() - Method in class com.arc_e_tect.gradle.jacoco.model.ExcludedElement

U

Usage - Search tag in class com.arc_e_tect.gradle.jacoco.JacocoExclusionReportPlugin: Section

V

valueOf(String) - Static method in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.arc_e_tect.gradle.jacoco.model.ExcludedElement.ElementType: Returns an array containing the constants of this enum class, in the order they are declared.

W

write(List<ExcludedElement>, String, File) - Method in class com.arc_e_tect.gradle.jacoco.report.HtmlReportWriter: Writes an HTML report to index.html inside outputDir.
write(List<ExcludedElement>, String, File) - Method in class com.arc_e_tect.gradle.jacoco.report.XmlReportWriter: Writes a Surefire-compatible XML report to jacoco-exclusions.xml inside outputDir.

X

XmlReportWriter - Class in com.arc_e_tect.gradle.jacoco.report: Writes a Surefire-compatible XML report so CI tools (Jenkins, GitLab, GitHub Actions test-reporter) can display exclusions alongside normal test results.
XmlReportWriter() - Constructor for class com.arc_e_tect.gradle.jacoco.report.XmlReportWriter: Creates a new XmlReportWriter.

A C D E F G H J L M N S T U V W X
All Classes and Interfaces|All Packages|Constant Field Values