net.jqwik.api.statistics

Annotation Type StatisticsReport

@Target(value={ANNOTATION_TYPE,METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @Repeatable(value=StatisticsReportList.class)
 @API(status=MAINTAINED,
     since="1.2.3")
public @interface StatisticsReport

This annotation can be used to influence statistics reporting. You can either annotate a property method to change reporting for this property only or a container class to change reporting for all properties in this class or nested subclasses.

There are three usage scenarios:

• Use @StatisticsReport(STANDARD) to enable the standard reporting. This is the default anyway.
• Use @StatisticsReport(OFF) to disable statistics reporting.
• Use @StatisticsReport(format = YourReportFormat.class) to plug in your own format.

This annotation is repeatable when used on property methods. In this case use label() to specify for which statistics collection the given report format shall be used.

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	ALL_LABELS

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<? extends StatisticsReportFormat>	format The format to be used for publishing statistics reports in the annotated property.
java.lang.String	label The statistics label to which the format in this annotation should be applied.
boolean	onFailureOnly Set to true when only failing properties should report their statistics
StatisticsReport.StatisticsReportMode	value

Field Detail

ALL_LABELS

public static final java.lang.String ALL_LABELS

Element Detail

value

public abstract StatisticsReport.StatisticsReportMode value

Default:

net.jqwik.api.statistics.StatisticsReport.StatisticsReportMode.PLUG_IN

format

public abstract java.lang.Class<? extends StatisticsReportFormat> format

The format to be used for publishing statistics reports in the annotated property.

Default:

net.jqwik.api.statistics.StatisticsReport.None.class

label

@API(status=MAINTAINED,
     since="1.5.1")
public abstract java.lang.String label

The statistics label to which the format in this annotation should be applied.

Default:

""

onFailureOnly

@API(status=EXPERIMENTAL,
     since="1.5.5")
public abstract boolean onFailureOnly

Set to true when only failing properties should report their statistics

Default:

false