doc / ch.tutteli.atrium.api.cc.infix.en_UK / toBe

toBe

infix fun <T : Any> Assert<T>.toBe(expected: T): AssertionPlant<T>

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

This method might enforce in the future, that expected has to be the same type as AssertionPlant.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.

infix fun <T> AssertionPlantNullable<T>.toBe(onlyNullAllowed: Nothing?): Unit

Makes the assertion that AssertionPlant.subject is null.

Parameters

onlyNullAllowed - Has to be null.

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?

infix fun <T : CharSequence> Assert<T>.toBe(Empty: Empty): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject.kotlin.text.isEmpty.

Parameters

Empty - Has to be Empty.

Exceptions

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

Return
This plant to support a fluent API.