doc / ch.tutteli.atrium.api.cc.infix.en_GB / first

first

val <K : Any> Assert<<ERROR CLASS><K, out <ERROR CLASS>>>.first: Assert<K> (source)

Creates an AssertionPlant for the Assert.subject's property first so that further fluent calls are assertions about it.

Wrap it into Kotlin's apply if you want to make subsequent assertions on the current subject or use the overload which expects an assertionCreatorOrNull lambda where sub assertions are evaluated together (form an assertion group block).

Return
The newly created AssertionPlant.

infix fun <K : Any, V> Assert<<ERROR CLASS><K, V>>.first(assertionCreator: Assert<K>.() -> Unit): AssertionPlant<<ERROR CLASS><K, V>> (source)

Makes the assertion that the Assert.subject's property first holds all assertions the given assertionCreator might create for it.

Exceptions

AssertionError - Might throw an AssertionError if a created Assertions (by calling assertionCreator) does not hold.

IllegalArgumentException - in case the given assertionCreator did not create a single assertion.

Return
This plant to support a fluent API.