Class IZagalaSpecDocumentSectionBuilder#

Inheritance Relationships#

Derived Types#

Class Documentation#

class IZagalaSpecDocumentSectionBuilder#

Builds the rows of one section of the feature document (e.g.

the feature header or the steps of a scenario). Sections are put in order by a FZagalaSpecDocumentLayout, so a section can be added, replaced, moved or removed without touching the other sections. Builders read the feature through the ZagalaSpec interfaces (IZagalaSpecFeature, IZagalaSpecScenarioInterface, IZagalaSpecDescriptor, …) and must not modify it.

Subclassed by FZagalaSpecFeatureHeaderSectionBuilder, FZagalaSpecScenarioHeaderSectionBuilder, FZagalaSpecScenarioStepsSectionBuilder, FZagalaSpecScenariosSectionBuilder, FZagalaSpecSharedContextExtensionsSectionBuilder

Public Functions

virtual ~IZagalaSpecDocumentSectionBuilder() = default#
virtual FName GetId() const = 0#

Identifies the section inside a layout.

Must be unique inside the layout.

Returns:

The section id (see ZagalaSpecDocumentSectionIds for the default ones).

virtual void Build(const FZagalaSpecDocumentBuildContext &Context, TArray<FZagalaSpecDocumentRowPtr> &OutRows) const = 0#

Appends the rows of this section.

Parameters:
  • Context – The feature (and scenario) the rows are built for.

  • OutRows – The rows built so far; the section appends its own rows at the end.