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

entries

fun <E : Any, T : Iterable<E>> CheckerOption<E, T, InAnyOrderSearchBehaviour>.entries(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: Assert<E>.() -> Unit): AssertionPlant<T> (source)

Finishes the specification of the sophisticated contains assertion where an entry shall be searched which holds all assertions assertionCreator might create -- likewise an entry (can be the same) is searched for each of the otherAssertionCreators.

Parameters

assertionCreator - The identification lambda which creates the assertions which the entry we are looking for has to hold; or in other words, the function which defines whether an entry is the one we are looking for or not.

otherAssertionCreators - Additional identification lambdas which each kind of identify (separately) an entry which we are looking for.

Exceptions

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

Return
The AssertionPlant for which the assertion was built to support a fluent API.

fun <E : Any, T : Iterable<E>> Builder<E, T, InAnyOrderOnlySearchBehaviour>.entries(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: Assert<E>.() -> Unit): AssertionPlant<T> (source)

Finishes the specification of the sophisticated contains assertion where the entry needs to be contained in the Iterable which holds all assertions assertionCreator might create -- likewise an entry for each otherAssertionCreators needs to be contained in the Iterable where it does not matter in which order the entries appear but only as many entries should be returned by the Iterable as assertion creators are defined.

Notice, that a first-wins strategy applies which means your assertion creator lambdas -- which kind of serve as identification lambdas -- should be ordered in such a way that the most specific identification lambda appears first, not that a less specific lambda wins. For instance, given a setOf(1, 2) you should not search for entries({ isGreaterThan(0) }, { toBe(1) }) but for entries({ toBe(1) }, { isGreaterThan(0) }) otherwise isGreaterThan(0) matches 1 before toBe(1) would match it. As a consequence toBe(1) could only match the entry which is left -- in this case 2 -- and of course this would fail.

Parameters

assertionCreator - The identification lambda which creates the assertions which the entry we are looking for has to hold; or in other words, the function which defines whether an entry is the one we are looking for or not.

otherAssertionCreators - Additional identification lambdas which each kind of identify (separately) an entry which we are looking for.

Exceptions

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

Return
The AssertionPlant for which the assertion was built to support a fluent API.

fun <E : Any, T : Iterable<E>> Builder<E, T, InOrderOnlySearchBehaviour>.entries(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: Assert<E>.() -> Unit): AssertionPlant<T> (source)

Finishes the specification of the sophisticated contains assertion where the Iterable needs to contain only an entry which holds all assertions assertionCreator might create and likewise a further entry for each otherAssertionCreators (if given) whereas the entries have to appear in the specified order.

Parameters

assertionCreator - The identification lambda which creates the assertions which the entry we are looking for has to hold; or in other words, the function which defines whether an entry is the one we are looking for or not.

otherAssertionCreators - Additional identification lambdas which each kind of identify (separately) an entry which we are looking for.

Exceptions

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

Return
The AssertionPlant for which the assertion was built to support a fluent API.