doc / ch.tutteli.atrium.core / CoreFactoryCommon / newReportingPlant

newReportingPlant

open fun <T : Any> newReportingPlant(assertionVerb: Translatable, subjectProvider: () -> T, reporter: Reporter): ReportingAssertionPlant<T>
Deprecated: Switch to Expect instead of Assert, thus use newReportingAssertionContainer instead; will be removed with 1.0.0

Creates a ReportingAssertionPlant which checks and reports added Assertions.

It creates a newThrowingAssertionChecker based on the given reporter for assertion checking, uses subjectProvider as AssertionPlantWithCommonFields.CommonFields.subjectProvider but also as AssertionPlantWithCommonFields.CommonFields.representationProvider. Notice that evalOnce is applied to the given subjectProvider to avoid undesired side effects (the provider is most likely called more than once).

Parameters

assertionVerb - The assertion verb which will be used inter alia in reporting (see AssertionPlantWithCommonFields.CommonFields.assertionVerb).

subjectProvider - Used as AssertionPlantWithCommonFields.CommonFields.subjectProvider but also as AssertionPlantWithCommonFields.CommonFields.representationProvider.

reporter - The reporter which will be used for a newThrowingAssertionChecker.

Return
The newly created assertion plant.

open fun <T : Any> newReportingPlant(assertionVerb: Translatable, subjectProvider: () -> T, assertionChecker: AssertionChecker): ReportingAssertionPlant<T>
Deprecated: Switch to Expect instead of Assert, thus use newReportingAssertionContainer instead; will be removed with 1.0.0

Creates a ReportingAssertionPlant which checks and reports added Assertions.

It uses the given assertionChecker for assertion checking, uses subjectProvider as AssertionPlantWithCommonFields.CommonFields.subjectProvider but also as AssertionPlantWithCommonFields.CommonFields.representationProvider. Notice that evalOnce is applied to the given subjectProvider to avoid side effects (the provider is most likely called more than once).

Parameters

assertionVerb - The assertion verb which will be used inter alia in reporting (see AssertionPlantWithCommonFields.CommonFields.assertionVerb).

subjectProvider - Used as AssertionPlantWithCommonFields.CommonFields.subjectProvider but also as AssertionPlantWithCommonFields.CommonFields.representationProvider.

assertionChecker - The checker which will be used to check Assertions. (see AssertionPlantWithCommonFields.CommonFields.assertionChecker).

Return
The newly created assertion plant.

abstract fun <T : Any> newReportingPlant(commonFields: AssertionPlantWithCommonFields.CommonFields<T>): ReportingAssertionPlant<T>
Deprecated: Switch to Expect instead of Assert, thus use newReportingAssertionContainer instead; will be removed with 1.0.0

Creates a ReportingAssertionPlant which checks and reports added Assertions.

It uses the AssertionPlantWithCommonFields.CommonFields.assertionChecker of the given commonFields for assertion checking

Parameters

commonFields - The commonFields for the new assertion plant.

Return
The newly created assertion plant.