atrium-core/ch.tutteli.atrium.assertions.builders/AssertionsOption

AssertionsOption

interface AssertionsOption<out T : AssertionGroupType, out R>(source)

Option step which allows to specify AssertionGroup.assertions.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val description: Translatable

The previously defined AssertionGroup.description.

Link copied to clipboard
abstract val groupType: T

The previously defined AssertionGroup.type.

Link copied to clipboard
abstract val representation: Any

The previously defined AssertionGroup.representation.

Functions

Link copied to clipboard
open fun withAssertion(assertion: Assertion): R

Uses the given assertion as single AssertionGroup.assertions.

Link copied to clipboard
abstract fun withAssertions(assertions: List<Assertion>): R

Uses the given assertions as AssertionGroup.assertions.

open fun withAssertions(assertion1: Assertion, assertion2: Assertion): R

Uses the given assertion1 and assertion2 as AssertionGroup.assertions.

open fun withAssertions(assertion1: Assertion, assertion2: Assertion, assertion3: Assertion): R

Uses the given assertion1, assertion2 and assertion3 as AssertionGroup.assertions.

Link copied to clipboard
fun <T : ExplanatoryAssertionGroupType> AssertionsOption<T, ExplanatoryGroup.FinalStep>.withExplanatoryAssertion(translatable: Translatable): ExplanatoryGroup.FinalStep

Defines that an ExplanatoryAssertion will be used as single Assertion in AssertionGroup.assertions where the given translatable is used as ExplanatoryAssertion.explanation.

fun <T : ExplanatoryAssertionGroupType> AssertionsOption<T, ExplanatoryGroup.FinalStep>.withExplanatoryAssertion(representation: Any?): ExplanatoryGroup.FinalStep

Defines that an ExplanatoryAssertion will be used as single Assertion in AssertionGroup.assertions where the given representation is used as ExplanatoryAssertion.explanation.

inline fun <T : ExplanatoryAssertionGroupType> AssertionsOption<T, ExplanatoryGroup.FinalStep>.withExplanatoryAssertion(explanationStep: (Explanatory.ExplanationOption) -> Assertion): ExplanatoryGroup.FinalStep

Defines that an ExplanatoryAssertion will be used as single Assertion in AssertionGroup.assertions where one can configure the ExplanatoryAssertion via the given explanationStep.

fun <T : ExplanatoryAssertionGroupType> AssertionsOption<T, ExplanatoryGroup.FinalStep>.withExplanatoryAssertion(translatable: Translatable, arg: Any, vararg otherArgs: Any): ExplanatoryGroup.FinalStep

Defines that an ExplanatoryAssertion will be used as single Assertion in AssertionGroup.assertions where the given translatable -- which is used in an TranslatableWithArgs together with the given arguments (arg and optionally otherArgs) -- is used as ExplanatoryAssertion.explanation.