JaCoCo - jacoco:report

# jacoco:report

Note:This goal should be used as a Maven report.

Full name:

org.jacoco:jacoco-maven-plugin:0.6.3.201306030806:report

Description:

Creates a code coverage report for a single project in multiple formats (HTML, XML, and CSV).

Attributes:

- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase: `verify`.

## Optional Parameters

Name | Type | Since | Description
dataFile | `File` | `-` | File with execution data. Default value is: `${project.build.directory}/jacoco.exec`.
excludes | `List` | `-` | A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.
includes | `List` | `-` | A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.
outputDirectory | `File` | `-` | Output directory for the reports. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead. Default value is: `${project.reporting.outputDirectory}/jacoco`.
outputEncoding | `String` | `-` | Encoding of the generated reports. Default value is: `UTF-8`.
skip | `boolean` | `-` | Flag used to suppress execution. Default value is: `false`.
sourceEncoding | `String` | `-` | Encoding of the source files. Default value is: `UTF-8`.

## Parameter Details

dataFile:

File with execution data.

- Type: `java.io.File`
- Required: `No`
- Default: `${project.build.directory}/jacoco.exec`

excludes:

A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.

- Type: `java.util.List`
- Required: `No`

includes:

A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.

- Type: `java.util.List`
- Required: `No`

outputDirectory:

Output directory for the reports. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

- Type: `java.io.File`
- Required: `No`
- Default: `${project.reporting.outputDirectory}/jacoco`

outputEncoding:

Encoding of the generated reports.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${project.reporting.outputEncoding}`
- Default: `UTF-8`

skip:

Flag used to suppress execution.

- Type: `boolean`
- Required: `No`
- Expression: `${jacoco.skip}`
- Default: `false`

sourceEncoding:

Encoding of the source files.

- Type: `java.lang.String`
- Required: `No`
- Expression: `${project.build.sourceEncoding}`
- Default: `UTF-8`