Package io.quarkus.jacoco.runtime

Class JacocoConfig

java.lang.Object

io.quarkus.jacoco.runtime.JacocoConfig

@ConfigRoot(phase=BUILD_AND_RUN_TIME_FIXED)
public class JacocoConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Optional<String>	dataFile	The jacoco data file.
Optional<List<String>>	excludes	A list of class files to exclude from the report.
Optional<String>	footer	Footer text used in HTML report pages.
List<String>	includes	A list of class files to include in the report.
static String	JACOCO_QUARKUS_EXEC
static String	JACOCO_REPORT
String	outputEncoding	Encoding of the generated reports.
boolean	report	If Quarkus should generate the Jacoco report
Optional<String>	reportLocation	The location of the report files.
boolean	reuseDataFile	Whether to reuse (true) or delete (false) the jacoco data file on each run.
String	sourceEncoding	Encoding of the source files.
static String	TARGET_JACOCO_QUARKUS_EXEC
static String	TARGET_JACOCO_REPORT
Optional<String>	title	Name of the root node HTML report pages.

Constructor Summary

Constructors

Constructor	Description
JacocoConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

JACOCO_QUARKUS_EXEC

public static final String JACOCO_QUARKUS_EXEC

See Also:

Constant Field Values

JACOCO_REPORT

public static final String JACOCO_REPORT

See Also:

Constant Field Values

TARGET_JACOCO_QUARKUS_EXEC

public static final String TARGET_JACOCO_QUARKUS_EXEC

See Also:

Constant Field Values

TARGET_JACOCO_REPORT

public static final String TARGET_JACOCO_REPORT

See Also:

Constant Field Values

dataFile

@ConfigItem
@ConfigDocDefault("target/jacoco-quarkus.exec")
public Optional<String> dataFile

The jacoco data file. The path can be relative (to the module) or absolute.

reuseDataFile

@ConfigItem(defaultValue="false")
public boolean reuseDataFile

Whether to reuse (true) or delete (false) the jacoco data file on each run.

report

@ConfigItem(defaultValue="true")
public boolean report

If Quarkus should generate the Jacoco report

outputEncoding

@ConfigItem(defaultValue="UTF-8")
public String outputEncoding

Encoding of the generated reports.

title

@ConfigItem
public Optional<String> title

Name of the root node HTML report pages.

footer

@ConfigItem
public Optional<String> footer

Footer text used in HTML report pages.

sourceEncoding

@ConfigItem(defaultValue="UTF-8")
public String sourceEncoding

Encoding of the source files.

includes

@ConfigItem(defaultValue="**")
public List<String> includes

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

For instance:

• **/fo/**/* targets all classes under fo and sub packages
• **/bar/* targets all classes directly under bar
• **/*BAR*.class targets classes that contain BAR in their name regardless of path

excludes

@ConfigItem
public Optional<List<String>> excludes

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

For instance:

• **/fo/**/* targets all classes under fo and sub packages
• **/bar/* targets all classes directly under bar
• **/*BAR*.class targets classes that contain BAR in their name regardless of path

reportLocation

@ConfigItem
@ConfigDocDefault("target/jacoco-report")
public Optional<String> reportLocation

The location of the report files. The path can be relative (to the module) or absolute.

Constructor Detail

JacocoConfig

public JacocoConfig()