doc / ch.tutteli.atrium / IAtriumFactory / newReportingPlantNullable

newReportingPlantNullable

open fun <T> newReportingPlantNullable(assertionVerb: Translatable, subject: T, reporter: Reporter, nullRepresentation: Any = RawString.NULL): ReportingAssertionPlantNullable<T>

Creates a ReportingAssertionPlantNullable which is the entry point for assertions about nullable types.

It creates a newThrowingAssertionChecker based on the given reporter for assertion checking.

Parameters

assertionVerb - The assertion verb which will be used inter alia in reporting (see AssertionPlantWithCommonFields.CommonFields.assertionVerb). subject - The subject for which this plant will create/check Assertions. (see AssertionPlantWithCommonFields.CommonFields.subject). reporter - The reporter which will be use for a newThrowingAssertionChecker.

Return
The newly created assertion plant.

open fun <T> newReportingPlantNullable(assertionVerb: Translatable, subject: T, assertionChecker: AssertionChecker, nullRepresentation: Any): ReportingAssertionPlantNullable<T>

Creates a ReportingAssertionPlantNullable which is the entry point for assertions about nullable types.

It uses the given assertionChecker for assertion checking.

Parameters

assertionVerb - The assertion verb which will be used inter alia in reporting (see AssertionPlantWithCommonFields.CommonFields.assertionVerb). subject - The subject for which this plant will create/check Assertions. (see AssertionPlantWithCommonFields.CommonFields.subject). assertionChecker - The checker which will be used to check Assertions. (see AssertionPlantWithCommonFields.CommonFields.assertionChecker).

Return
The newly created assertion plant.

abstract fun <T> newReportingPlantNullable(commonFields: CommonFields<T>): ReportingAssertionPlantNullable<T>

Creates a ReportingAssertionPlantNullable which is the entry point for assertions about nullable types.

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.