net.jqwik.api

Interface Reporter

@API(status=MAINTAINED,
     since="1.4.0")
public interface Reporter

An interface that can be used to report additional information for a test element, i.e. a test container or property.

To get access to a reporter object, just add a parameter of type Reporter to the property method or any lifecycle method.

Reporting additional test information is a JUnit 5 platform feature. Some tools will output this information to stdout; other tools, e.g. Gradle as of version 6, ignore it. That's why jqwik prints this information to stdout itself unless told otherwise.

Method Summary

Modifier and Type	Method and Description
void	publishReport(java.lang.String key, java.lang.Object object) Publish a report about object under a given key.
void	publishReports(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> objects) Publish reports about objects under a given key.
void	publishValue(java.lang.String key, java.lang.String value) Publish some value under a given key.

Method Detail

publishValue

void publishValue(java.lang.String key,
                  java.lang.String value)

Publish some value under a given key.

Parameters:

key - a String

value - a String

publishReport

void publishReport(java.lang.String key,
                   java.lang.Object object)

Publish a report about object under a given key.

This uses the same mechanism used for jqwik's failure reporting.

Parameters:

key - a String

object - any object

publishReports

void publishReports(java.lang.String key,
                    java.util.Map<java.lang.String,java.lang.Object> objects)

Publish reports about objects under a given key.

This uses the same mechanism used for jqwik's failure reporting.

Parameters:

key - a String

objects - a map of objects the key of which is used to enumerate them