Package net.jqwik.api
Interface Reporter
-
@API(status=MAINTAINED, since="1.4.0") public interface ReporterAn 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
Reporterto 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidpublishReport(java.lang.String key, java.lang.Object object)Publish a report aboutobjectunder a givenkey.voidpublishReports(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> objects)Publish reports aboutobjectsunder a givenkey.voidpublishValue(java.lang.String key, java.lang.String value)Publish somevalueunder a givenkey.
-
-
-
Method Detail
-
publishValue
void publishValue(java.lang.String key, java.lang.String value)Publish somevalueunder a givenkey.- Parameters:
key- a Stringvalue- a String
-
publishReport
void publishReport(java.lang.String key, java.lang.Object object)Publish a report aboutobjectunder a givenkey.This uses the same mechanism used for jqwik's failure reporting.
- Parameters:
key- a Stringobject- any object
-
publishReports
void publishReports(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> objects)Publish reports aboutobjectsunder a givenkey.This uses the same mechanism used for jqwik's failure reporting.
- Parameters:
key- a Stringobjects- a map of objects the key of which is used to enumerate them
-
-