doc / ch.tutteli.atrium.assertions.builders / Explanatory / ExplanationOption

ExplanationOption

interface ExplanationOption (source)

Option step which allows to specify ExplanatoryAssertion.explanation.

Functions

withDescription

open fun withDescription(translatable: Translatable, arg: Any, vararg otherArgs: Any): FinalStep

Uses the given translatable together with the arg and optionally otherArgs to create an TranslatableWithArgs which is then used as ExplanatoryAssertion.explanation.

open fun withDescription(translatable: Translatable): FinalStep

Uses the given translatable as explanation.

abstract fun withDescription(explanation: Any?): FinalStep

Uses the given explanation as ExplanatoryAssertion.explanation.

Companion Object Functions

create

fun create(): ExplanationOption

Factory method to create the ExplanationOption step in the building process of an ExplanatoryAssertion.