Package net.jqwik.api.statistics
Interface StatisticsCollector
-
@API(status=MAINTAINED, since="1.2.3") public interface StatisticsCollector
This class serves as an interface to collect statistical data about generated values within a property method.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StatisticsCollector
collect(java.lang.Object... values)
Call this method to record an entry for statistical data about generated values.void
coverage(java.util.function.Consumer<StatisticsCoverage> checker)
Perform coverage checking for successful property on statistics.
-
-
-
Method Detail
-
collect
StatisticsCollector collect(java.lang.Object... values)
Call this method to record an entry for statistical data about generated values. As soon as this method is called at least once in a property method, the statistical data will be reported after the property has finished.For examples see Statistics.collect(Object...)
- Parameters:
values
- Can be anything. The list of these values is considered a key for the reported table of frequencies. Constraints:- There must be at least one value
- The number of values for the same collector (i.e. same label) must always be the same in a single property
- Values can be
null
- Returns:
- The current instance of collector to allow a fluent coverage API
- Throws:
java.lang.IllegalArgumentException
- if one of the constraints onvalues
is violated
-
coverage
@API(status=EXPERIMENTAL, since="1.2.3") void coverage(java.util.function.Consumer<StatisticsCoverage> checker)
Perform coverage checking for successful property on statistics.For examples see Statistics.coverage(Consumer)
- Parameters:
checker
- Code that consumes a StatisticsCoverage object
-
-