Package net.jqwik.api

Interface SampleReportingFormat

All Superinterfaces:

java.lang.Comparable<SampleReportingFormat>

All Known Implementing Classes:

JavaBeanReportingFormat

@API(status=EXPERIMENTAL,
     since="1.3.1")
public interface SampleReportingFormat
extends java.lang.Comparable<SampleReportingFormat>

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(java.lang.Object value)
default int	compareTo(SampleReportingFormat other)
default java.util.Optional<java.lang.String>	label(java.lang.Object value)
static java.lang.Object	plainLabel(java.lang.String plain)	Use in report(Object) if you just want to report a plain label and not a String in quotes.
default int	priority()
java.lang.Object	report(java.lang.Object value)	Transform the value into one that will be handled by default mechanism, e.g. a Collection, a String, a Map.
static java.lang.Object	reportJavaBean(java.lang.Object bean)	Deprecated. Make an implementation of JavaBeanReportingFormat instead.

Method Detail

reportJavaBean

@Deprecated
@API(status=DEPRECATED,
     since="1.3.10")
static java.lang.Object reportJavaBean(java.lang.Object bean)

Deprecated.

Make an implementation of JavaBeanReportingFormat instead. To be removed in 1.4.0.

Use in report(Object) if you just want to report all of an object's bean properties as attributes.

Parameters:

bean - Java object with its properties following the bean convention

Returns:

a map with all bean properties in alphabetical order

plainLabel

static java.lang.Object plainLabel(java.lang.String plain)

Use in report(Object) if you just want to report a plain label and not a String in quotes.

Parameters:

plain - String to report

Returns:

an object that will be reported as a plain label

appliesTo

boolean appliesTo(java.lang.Object value)

Parameters:

value - the value to format

Returns:

true if this format applies

report

java.lang.Object report(java.lang.Object value)

Transform the value into one that will be handled by default mechanism, e.g. a Collection, a String, a Map.

Parameters:

value - the value to format

Returns:

the transformed value

label

default java.util.Optional<java.lang.String> label(java.lang.Object value)

Parameters:

value - the value to format

Returns:

an optional label prepended to a value's report

priority

default int priority()

Returns:

priority with which to apply this format

compareTo

@API(status=INTERNAL)
default int compareTo(SampleReportingFormat other)

Specified by:

compareTo in interface java.lang.Comparable<SampleReportingFormat>