doc / ch.tutteli.atrium.api.cc.en_GB / toBe

toBe

fun <T : Any> Assert<T>.toBe(expected: T): AssertionPlant<T>
Deprecated: Switch from Assert to Expect; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

Makes the assertion that the Assert.subject is (equal to) expected.

This method might enforce in the future, that expected has to be the same type as Assert.subject. Currently the following is possible: assert(1).toBe(1.0)

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

Return
This plant to support a fluent API.

inline fun <reified T : Any> AssertionPlantNullable<T?>.toBe(expected: T?): Unit
Deprecated: Switch from Assert to Expect; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

Makes the assertion that the Assert.subject is expected.

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

Return
Does not support a fluent API because: what else would you want to assert about null anyway?

fun <T> toBe(plant: AssertionPlantNullable<T>, void: Void?): Unit
Deprecated: Use the extension function, will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.