atrium-core/ch.tutteli.atrium.assertions.builders/DescriptiveAssertionWithFailureHint/FinalStep

FinalStep

interface FinalStep : AssertionBuilderFinalStep<Assertion> (source)

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.

Types

object Companion

Provides factory methods to create a FinalStep and serves as extension point.

Properties

abstract val description: Translatable

The previously defined DescriptiveAssertion.description.

failureHintFactory

abstract val failureHintFactory: () -> Assertion

The previously defined factory method which creates the failure hint.

abstract val representation: Any

The previously defined DescriptiveAssertion.representation.

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.

abstract val test: () -> Boolean

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

Functions

abstract fun build(): Assertion

Creates and returns the new Assertion of type T.