net.jqwik.api.footnotes

Interface Footnotes

@API(status=MAINTAINED,
     since="1.5.5")
public interface Footnotes

An interface that can be used to add information to the report of a failing property. The footnotes will be shown for the original failing sample and the shrunk sample.

To enable footnote support you have to use annotation EnableFootnotes. To get access to a footnotes object, just add a parameter of type Footnotes to the property method or any lifecycle method.

Method Summary

Modifier and Type	Method and Description
void	addAfterFailure(java.util.function.Supplier<java.lang.String> footnoteSupplier)
void	addFootnote(java.lang.String footnote) Add a footnote to be displayed in case of failure.

Method Detail

addFootnote

void addFootnote(java.lang.String footnote)

Add a footnote to be displayed in case of failure.

Parameters:

footnote - a String

addAfterFailure

@API(status=EXPERIMENTAL,
     since="1.7.2")
void addAfterFailure(java.util.function.Supplier<java.lang.String> footnoteSupplier)