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

ExplanationOption

interface ExplanationOption (source)

Option step which allows to specify an ExplanatoryAssertion.explanation.

Functions

withDescription

 open fun withDescription(translatable: Translatable, arg: Any, vararg otherArgs: Any): Explanatory.FinalStep
open fun withDescription(translatable: Translatable): Explanatory.FinalStep
open fun withDescription(explanation: Any?): Explanatory.FinalStep

withExplanation

 open fun withExplanation(translatable: Translatable, arg: Any, vararg otherArgs: Any): Explanatory.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 withExplanation(description: String): Explanatory.FinalStep

Uses the given description as explanation.

abstract fun withExplanation(explanation: Any?): Explanatory.FinalStep

Uses the given explanation as ExplanatoryAssertion.explanation.

Companion Object Functions

create

 fun create(): Explanatory.ExplanationOption

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