Package net.jqwik.api

Class JavaBeanReportingFormat

java.lang.Object

net.jqwik.api.JavaBeanReportingFormat

All Implemented Interfaces:

Comparable<SampleReportingFormat>, SampleReportingFormat

@API(status=MAINTAINED,
     since="1.3.10")
public abstract class JavaBeanReportingFormat
extends Object
implements SampleReportingFormat

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaBeanReportingFormat.JavaBeanReportingFormatFacade

Constructor Summary

Constructors

Constructor	Description
JavaBeanReportingFormat()

Method Summary

Modifier and Type	Method	Description
boolean	appliesTo(Object value)
protected abstract Collection<Class<?>>	beanTypes()
protected Collection<String>	excludeProperties()
Optional<String>	label(Object value)
final Object	report(Object value)	Transform the value into one that will be handled by default mechanism, e.g. a Collection, a String, a Map.
protected boolean	reportNulls()
protected List<String>	sortProperties(List<String> properties)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.jqwik.api.SampleReportingFormat

compareTo, priority

Constructor Details

JavaBeanReportingFormat

public JavaBeanReportingFormat()

Method Details

beanTypes

protected abstract Collection<Class<?>> beanTypes()

excludeProperties

protected Collection<String> excludeProperties()

sortProperties

protected List<String> sortProperties(List<String> properties)

reportNulls

protected boolean reportNulls()

label

public Optional<String> label(Object value)

Specified by:

label in interface SampleReportingFormat

Parameters:

value - the value to format

Returns:

an optional label prepended to a value's report

appliesTo

public boolean appliesTo(Object value)

Specified by:

appliesTo in interface SampleReportingFormat

Parameters:

value - the value to format

Returns:

true if this format applies

report

public final Object report(Object value)

Description copied from interface: SampleReportingFormat

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

Specified by:

report in interface SampleReportingFormat

Parameters:

value - the value to format

Returns:

the transformed value