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

TextAssertionFormatterOption

expect interface TextAssertionFormatterOption : TextAssertionFormatterOptionCommon (source)
Deprecated: Configure components via withOptions when creating an expectation verb instead; will be removed with 0.17.0

Provides options to register AssertionFormatters to the chosen AssertionFormatterFacade -- the platform specific interface might provide further options.

Inherited 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

 open fun withDefaultTextCapabilities(vararg bulletPoints: Pair<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.

Inherited Functions

withTextAssertionFormatter

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

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

withTextCapabilities

 abstract fun withTextCapabilities(vararg bulletPoints: Pair<KClass<out BulletPointIdentifier>, String>): AtriumErrorAdjusterOption

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.

Companion Object Functions

create

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