Package com.arc_e_tect.gradle.gherkin.progress

Record Class ProgressReportOptions

java.lang.Object
java.lang.Record
com.arc_e_tect.gradle.gherkin.progress.ProgressReportOptions
Record Components:
groupByFeature - whether to group scenarios by their enclosing Feature, within each status, instead of a flat list
snippetDir - directory to write the listed.adoc/defined.adoc/ implemented.adoc snippet files to
template - a Mustache template file used to render the report so that it includes the generated snippets rather than embedding their content verbatim; null to use the built-in default report layout
systemUnderTestVersion - version of the system under test that the reported scenarios exercise, printed near the top of the report
history - the persisted scenario progress history, keyed by fingerprint, to render a == Progress Over Time section from; null or empty when trackProgressHistory is disabled, in which case no such section is rendered
public record ProgressReportOptions(boolean groupByFeature, File snippetDir, File template, String systemUnderTestVersion, Map<String,ScenarioProgressRecord> history) extends Record
Configuration for ProgressReportWriter.

  • Constructor Details

    • ProgressReportOptions

      public ProgressReportOptions(boolean groupByFeature, File snippetDir, File template, String systemUnderTestVersion)
      Creates options with progress history tracking disabled (history() empty).
      Parameters:
      groupByFeature - whether to group scenarios by their enclosing Feature
      snippetDir - directory to write the report snippet files to
      template - optional Mustache template file, or null
      systemUnderTestVersion - version of the system under test that the reported scenarios exercise

    • ProgressReportOptions

      public ProgressReportOptions(boolean groupByFeature, File snippetDir, File template, String systemUnderTestVersion, Map<String,ScenarioProgressRecord> history)
      Defensively copies history into an immutable map, defaulting a null to empty.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • groupByFeature

      public boolean groupByFeature()
      Returns the value of the groupByFeature record component.
      Returns:
      the value of the groupByFeature record component

    • snippetDir

      public File snippetDir()
      Returns the value of the snippetDir record component.
      Returns:
      the value of the snippetDir record component

    • template

      public File template()
      Returns the value of the template record component.
      Returns:
      the value of the template record component

    • systemUnderTestVersion

      public String systemUnderTestVersion()
      Returns the value of the systemUnderTestVersion record component.
      Returns:
      the value of the systemUnderTestVersion record component

    • history

      public Map<String,ScenarioProgressRecord> history()
      Returns the value of the history record component.
      Returns:
      the value of the history record component