doc / ch.tutteli.atrium.domain.builders.reporting / TextAssertionFormatterOption

TextAssertionFormatterOption

interface TextAssertionFormatterOption (source)

Provides options to register AssertionFormatters to the chosen AssertionFormatterFacade.

Properties

assertionPairFormatter

abstract val assertionPairFormatter: AssertionPairFormatter

The previously chosen AssertionPairFormatter.

options

abstract val options: AssertionFormatterChosenOptions

The so far chosen options which are relevant to create AssertionFormatters.

Functions

withDefaultTextCapabilities

abstract fun withDefaultTextCapabilities(vararg bulletPoints: <ERROR CLASS><Class<out BulletPointIdentifier>, String>): ReporterOption

Uses CoreFactory.registerTextAssertionFormatterCapabilities to register the default AssertionFormatters intended for text output -- using the defined assertionPairFormatter, AssertionFormatterChosenOptions.objectFormatter and AssertionFormatterChosenOptions.translator -- to the specified AssertionFormatterChosenOptions.assertionFormatterFacade where the given bulletPoints can be used to customise the predefined bullet points.

withTextAssertionFormatter

abstract fun withTextAssertionFormatter(factory: (AssertionFormatterChosenOptions) -> (AssertionFormatterController) -> AssertionFormatter, vararg otherFactories: (AssertionFormatterChosenOptions) -> (AssertionFormatterController) -> AssertionFormatter): ReporterOption

Uses the given factory and otherFactories to create and register AssertionFormatters to the specified AssertionFormatterChosenOptions.assertionFormatterFacade.

Companion Object Functions

create

fun create(options: AssertionFormatterChosenOptions, assertionPairFormatter: AssertionPairFormatter): TextAssertionFormatterOption