doc / ch.tutteli.atrium.assertions.builders / Descriptive / HoldsOption

HoldsOption

interface HoldsOption (source)

Option step which allows to specify DescriptiveAssertion.holds.

Properties

failing

abstract val failing: Descriptive.DescriptionOption<Descriptive.FinalStep>

Defines a constant failing assertion.

holding

abstract val holding: Descriptive.DescriptionOption<Descriptive.FinalStep>

Defines a constant holding assertion.

Functions

withTest

abstract fun withTest(test: () -> Boolean): Descriptive.DescriptionOption<Descriptive.FinalStep>

Uses the given test as DescriptiveAssertion.holds.

abstract fun <T> withTest(expect: Expect<T>, test: (T) -> Boolean): Descriptive.DescriptionOption<Descriptive.FinalStep>

Uses the given test as DescriptiveAssertion.holds based on the subject provided by expect.

Companion Object Functions

create

fun create(): Descriptive.HoldsOption

Factory method to create the HoldsOption step in the process of building a descriptive assertion.