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

DescriptionOption

interface DescriptionOption<R> (source)

Option step which allows to specify the description of a descriptive like assertion (such as DescriptiveAssertion).

Properties

test	`abstract val test: () -> Boolean` The previously defined test which is used to determine Assertion.holds.

Functions

withDescriptionAndRepresentation

open fun withDescriptionAndRepresentation(description: String, representation: Any?): R

Wraps the given description into an Untranslatable and uses it as DescriptiveAssertion.description next to representation which is used as DescriptiveAssertion.representation unless representation is null in which case a representation for null is used (e.g. Text.NULL).

abstract fun withDescriptionAndRepresentation(description: Translatable, representation: Any?): R

Uses the given description as DescriptiveAssertion.description and representation as DescriptiveAssertion.representation unless representation is null in which case a representation for null is used (e.g. Text.NULL).

Companion Object Functions

create

fun <R> create(test: () -> Boolean, factory: (() -> Boolean, Translatable, Any) -> R): Descriptive.DescriptionOption<R>

Factory method to create the DescriptionOption step based on the given test and another factory method which creates the next step in the building process of a descriptive assertion.

Extension Functions

withFailureHint	`fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHint(failureHintFactory: () -> Assertion): DescriptiveAssertionWithFailureHint.ShowOption` Option to create a DescriptiveAssertion like assertion with an additional hint which might be shown if the Descriptive.DescriptionOption.test fails.
withFailureHintBasedOnDefinedSubject	`fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHintBasedOnDefinedSubject(expect: Expect<T>, failureHintFactory: (T) -> Assertion): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep>` Option to create a DescriptiveAssertion like assertion with an additional hint which is based on the subject of the expectation and which is only shown the subject is defined.
withFailureHintBasedOnSubject	`fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withFailureHintBasedOnSubject(expect: Expect<T>, failureHintSubStep: DescriptiveAssertionWithFailureHint.FailureHintSubjectDefinedOption<T>.() -> Pair<() -> Assertion, (T) -> Assertion>): DescriptiveAssertionWithFailureHint.ShowOption` Option to create a DescriptiveAssertion like assertion with an additional hint (which is based on the subject of the expectation) which might be shown if the Descriptive.DescriptionOption.test fails.
withFileAttributesFailureHint	`fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withFileAttributesFailureHint(expect: Expect<IoResult<BasicFileAttributes>>): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep>`
withHelpOnFailure	`fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailure(failureHintFactory: () -> Assertion): DescriptiveAssertionWithFailureHint.ShowOption` Option to create a DescriptiveAssertion like assertion with an additional hint which might be shown if the Descriptive.DescriptionOption.test fails.
withHelpOnFailureBasedOnDefinedSubject	`fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailureBasedOnDefinedSubject(expect: Expect<T>, failureHintFactory: (T) -> Assertion): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep>` Option to create a DescriptiveAssertion like assertion with an additional hint which is based on the subject of the expectation and which is only shown the subject is defined.
withHelpOnFailureBasedOnSubject	`fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFailureBasedOnSubject(expect: Expect<T>, failureHintSubStep: DescriptiveAssertionWithFailureHint.FailureHintSubjectDefinedOption<T>.() -> Pair<() -> Assertion, (T) -> Assertion>): DescriptiveAssertionWithFailureHint.ShowOption` Option to create a DescriptiveAssertion like assertion with an additional hint (which is based on the subject of the expectation) which might be shown if the Descriptive.DescriptionOption.test fails.
withHelpOnFileAttributesFailure	`fun Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnFileAttributesFailure(expect: Expect<IoResult<BasicFileAttributes>>): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep>`
withHelpOnIOExceptionFailure	`fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withHelpOnIOExceptionFailure(expect: Expect<IoResult<T>>, f: (Path, IOException) -> Assertion?): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep>`
withIOExceptionFailureHint	`fun <T> Descriptive.DescriptionOption<Descriptive.FinalStep>.withIOExceptionFailureHint(expect: Expect<IoResult<T>>, f: (Path, IOException) -> Assertion?): Descriptive.DescriptionOption<DescriptiveAssertionWithFailureHint.FinalStep>`