JacocoTaskExtension - Gradle DSL Version 2.14.1

# JacocoTaskExtension

API Documentation: | `JacocoTaskExtension`

Note: This class is incubating and may change in a future version of Gradle.

Extension for tasks that should run with a Jacoco agent to generate coverage execution data.

### Properties

Property | Description
`address` | Incubating IP address or hostname to use with `Output.TCP_SERVER` or `Output.TCP_CLIENT`. Defaults to localhost.
`append` | Incubating Whether or not data should be appended if the `destinationFile` already exists. Defaults to `true`.
`classDumpFile` | Incubating Path to dump all class files the agent sees are dumped to. Defaults to no dumps.
`destinationFile` | Incubating The path for the execution data to be written to.
`dumpOnExit` | Incubating Whether or not to dump the coverage data at VM shutdown. Defaults to `true`.
`excludeClassLoaders` | Incubating List of classloader names that should be excluded from analysis. Names can use wildcards (* and ?). Defaults to an empty list.
`excludes` | Incubating List of class names that should be excluded from analysis. Names can use wildcard (* and ?). Defaults to an empty list.
`includes` | Incubating List of class names that should be included in analysis. Names can use wildcards (* and ?). If left empty, all classes will be included. Defaults to an empty list.
`jmx` | Incubating Whether or not to expose functionality via JMX under `org.jacoco:type=Runtime`. Defaults to `false`. The configuration of the jmx property is only taken into account if the used JaCoCo version supports this option (JaCoCo version >= 0.6.2)
`output` | Incubating The type of output to generate. Defaults to `Output.FILE`.
`port` | Incubating Port to bind to for `Output.TCP_SERVER` or `Output.TCP_CLIENT`. Defaults to 6300.
`sessionId` | Incubating An identifier for the session written to the execution data. Defaults to an auto-generated identifier.

### Methods

Method | Description
`getAsJvmArg()` | Incubating Gets all properties in the format expected of the agent JVM argument.

### Script blocks

No script blocks

### Property details

#### `String` `address`

Note: This property is incubating and may change in a future version of Gradle.

IP address or hostname to use with `Output.TCP_SERVER` or `Output.TCP_CLIENT`. Defaults to localhost.

#### `boolean` `append`

Note: This property is incubating and may change in a future version of Gradle.

Whether or not data should be appended if the `destinationFile` already exists. Defaults to `true`.

#### `File` `classDumpFile`

Note: This property is incubating and may change in a future version of Gradle.

Path to dump all class files the agent sees are dumped to. Defaults to no dumps.

#### `File` `destinationFile`

Note: This property is incubating and may change in a future version of Gradle.

The path for the execution data to be written to.

#### `boolean` `dumpOnExit`

Note: This property is incubating and may change in a future version of Gradle.

Whether or not to dump the coverage data at VM shutdown. Defaults to `true`.

#### ``List`<`String`>` `excludeClassLoaders`

Note: This property is incubating and may change in a future version of Gradle.

List of classloader names that should be excluded from analysis. Names can use wildcards (* and ?). Defaults to an empty list.

#### ``List`<`String`>` `excludes`

Note: This property is incubating and may change in a future version of Gradle.

List of class names that should be excluded from analysis. Names can use wildcard (* and ?). Defaults to an empty list.

#### ``List`<`String`>` `includes`

Note: This property is incubating and may change in a future version of Gradle.

List of class names that should be included in analysis. Names can use wildcards (* and ?). If left empty, all classes will be included. Defaults to an empty list.

#### `boolean` `jmx`

Note: This property is incubating and may change in a future version of Gradle.

Whether or not to expose functionality via JMX under `org.jacoco:type=Runtime`. Defaults to `false`. The configuration of the jmx property is only taken into account if the used JaCoCo version supports this option (JaCoCo version >= 0.6.2)

#### `Output` `output`

Note: This property is incubating and may change in a future version of Gradle.

The type of output to generate. Defaults to `Output.FILE`.

#### `int` `port`

Note: This property is incubating and may change in a future version of Gradle.

Port to bind to for `Output.TCP_SERVER` or `Output.TCP_CLIENT`. Defaults to 6300.

#### `String` `sessionId`

Note: This property is incubating and may change in a future version of Gradle.

An identifier for the session written to the execution data. Defaults to an auto-generated identifier.

### Method details

#### `String` `getAsJvmArg`()

Note: This method is incubating and may change in a future version of Gradle.

Gets all properties in the format expected of the agent JVM argument.