doc / ch.tutteli.atrium.assertions.builders / DescriptiveAssertionWithFailureHint / FinalStep

FinalStep

interface FinalStep : AssertionBuilderFinalStep<Assertion>

Final step which creates a DescriptiveAssertion if the test holds or an AssertionGroup which includes additionally a failure hint created by the given failureHintFactory in case showHint evaluates to true.

Properties

description

abstract val description: Translatable

The previously defined DescriptiveAssertion.description.

failureHintFactory

abstract val failureHintFactory: () -> Assertion

The previously defined factory method which creates the failure hint.

representation

abstract val representation: Any

The previously defined DescriptiveAssertion.representation.

showHint

abstract val showHint: () -> Boolean

The previously defined showHint predicate which defines whether the failure hint shall be shown in case the assertion fails or not.

test

abstract val test: () -> Boolean

The previously defined test which is used to determine DescriptiveAssertion.holds.

Inherited Functions

build

abstract fun build(): T

Creates and returns the new Assertion of type T.

Companion Object Functions

create

fun create(test: () -> Boolean, showHint: () -> Boolean, failureHintFactory: () -> Assertion, description: Translatable, representation: Any): DescriptiveAssertionWithFailureHint.FinalStep