atrium-logic/ch.tutteli.atrium.logic.creating/RootExpectBuilder/OptionsStep

OptionsStep

Step which allows to override previously defined properties -- such as use a different expectation verb -- but also allows to define options where usually a default value is used, such as use a custom Reporter.

Parameters

the type of the subject.

Inheritors

OptionsStepImpl

Types

Companion

object Companion

Properties

expectationVerb

abstract val expectationVerb: Translatable

The previously defined expectation verb.

subject

abstract val subject: T

The previously specified subject of the expectation.

Functions

withOptions

abstract fun withOptions(rootExpectOptions: RootExpectOptions<T>): RootExpectBuilder.FinalStep<T>

Uses the given rootExpectOptions.

open fun withOptions(configuration: RootExpectBuilder.OptionsChooser<T>.() -> Unit): RootExpectBuilder.FinalStep<T>

Allows to define the RootExpectOptions via an OptionsChooser-lambda which provides convenience functions.

withoutOptions

abstract fun withoutOptions(): RootExpectBuilder.FinalStep<T>

States explicitly that no optional RootExpectOptions are defined, which means, build will create a new Expect based on the previously defined mandatory options but without any optional options or in other words, the default values are used for the optional options.