net.jqwik.api.Reporter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jqwik-api Show documentation

Jqwik API module

There is a newer version: 1.9.2

package net.jqwik.api;

import java.util.*;

import org.apiguardian.api.*;

import static org.apiguardian.api.API.Status.*;

/**
 * An interface that can be used to report additional information for a test element,
 * i.e. a test container or property.
 *
 * 
 * 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.
 * 
 */
@API(status = MAINTAINED, since = "1.4.0")
public interface Reporter {

	/**
	 * Publish some {@code value} under a given {@code key}.
	 *
	 * @param key   a String
	 * @param value a String
	 */
	void publishValue(String key, String value);

	/**
	 * Publish a report about {@code object} under a given {@code key}.
	 *
	 * 
	 * This uses the same mechanism used for jqwik's
	 * failure reporting.
	 * 
	 *
	 * @param key    a String
	 * @param object any object
	 */
	void publishReport(String key, Object object);

	/**
	 * Publish reports about {@code objects} under a given {@code key}.
	 *
	 * 
	 * This uses the same mechanism used for jqwik's
	 * failure reporting.
	 * 
	 *
	 * @param key    a String
	 * @param objects a map of objects the key of which is used to enumerate them
	 */
	void publishReports(String key, Map objects);
}