doc / ch.tutteli.atrium.reporting / AssertionPairFormatter

AssertionPairFormatter

interface AssertionPairFormatter (source)

Represents a formatter of assertion pairs -- which consists of a Translatable and a representation.

Functions

format

abstract fun format(parameterObject: AssertionFormatterParameterObject, translatable: Translatable, representation: Any): Unit

Formats the assertion pair consisting of the given translatable and the given representation and appends the result to the sb of the given parameterObject.

formatGroupHeader

abstract fun formatGroupHeader(parameterObject: AssertionFormatterParameterObject, assertionGroup: AssertionGroup, newParameterObject: AssertionFormatterParameterObject): Unit

Formats the header (AssertionGroup.description and AssertionGroup.representation) of the given assertionGroup and appends the result to the sb of the given parameterObject.

Inheritors

TextAssertionPairFormatter

interface TextAssertionPairFormatter : AssertionPairFormatter

Marker interface for AssertionPairFormatter which are intended for text output, e.g. for terminal output.

TextNextLineAssertionPairFormatter

class TextNextLineAssertionPairFormatter : AssertionPairFormatter, TextAssertionPairFormatter

Represents an AssertionPairFormatter formatter of assertion pairs -- which consists of a Translatable and a representation -- where it puts the translation on one line and the representation on the next line (including indentation as if the representation is a child).

TextSameLineAssertionPairFormatter

class TextSameLineAssertionPairFormatter : AssertionPairFormatter, TextAssertionPairFormatter

Represents an AssertionPairFormatter formatter of assertion pairs -- which consists of a Translatable and a representation -- where it puts them on the same line in the form: translation: representation.