Package net.jqwik.api

Interface SampleReportingFormat

All Superinterfaces:
Comparable<SampleReportingFormat>
All Known Implementing Classes:
JavaBeanReportingFormat
@API(status=MAINTAINED, since="1.4.0") public interface SampleReportingFormat extends Comparable<SampleReportingFormat>

  • Method Details

    • plainLabel

      static Object plainLabel(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(Object value)
      Parameters:
      value - the value to format
      Returns:
      true if this format applies

    • report

      Object report(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 Optional<String> label(Object value)
      Parameters:
      value - the value to format
      Returns:
      an optional label prepended to a value's report

    • priority

      default int priority()
      Higher priorities have precedence.
      Returns:
      priority with which to apply this format

    • compareTo

      @API(status=INTERNAL) default int compareTo(SampleReportingFormat other)
      Specified by:
      compareTo in interface Comparable<SampleReportingFormat>