net.jqwik.api.statistics.StatisticsReportFormat 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.statistics;

import java.util.*;

import org.apiguardian.api.*;

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

/**
 * An implementation of this interface is responsible for creating
 * a formatted statistics report.
 *
 * 
 * Implementation of this class must have a public default constructor
 * to be usable in {@linkplain StatisticsReport#format()}
 * 
 *
 * @see StatisticsReport
 */
@API(status = EXPERIMENTAL, since = "1.2.3")
public interface StatisticsReportFormat {

	/**
	 * Return a list of report lines. Often, one line will represent one entry
	 * but that must not necessarily be the case.
	 *
	 * @return All report lines. No trailing `CR` or `LF` characters are needed.
	 *
	 * @see StatisticsEntry
	 */
	List formatReport(List entries);
}