atrium-api-cc-infix-en_UK / ch.tutteli.atrium.api.cc.infix.en_UK / ch.tutteli.atrium.assertions.iterable.contains.builders.IterableContainsCheckerBuilder / the

the

infix fun <E, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.the(values: Values<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected values shall be searched within the Iterable.

Delegates to the Objects(values).

Parameters

values - The values which are expected to be contained within the Iterable.

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.

infix fun <E, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.the(objects: Objects<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected objects shall be searched within the iterable.

Notice, that it does not search for unique matches. Meaning, if the iterable is setOf('a', 'b') and Objects.expected is defined as 'a' and one Objects.otherExpected is defined as 'a' as well, then both match, even though they match the same entry. Use an option such as atLeast, atMost and exactly to control the number of occurrences you expect.

Meaning you might want to use: to contain inAny order exactly 2 `object` 'a' instead of: to contain inAny order exactly 1 the Objects('a', 'a')

Parameters

objects - The objects which are expected to be contained within the Iterable.

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.

infix fun <E : Any, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.the(entries: Entries<E, Assert<E>.() -> Unit>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where an entry shall be searched which holds all assertions Entries.assertionCreator might create and search for entries which hold (one by one) the assertions created by the Entries.otherAssertionCreators.

Parameters

entries - The method object which contains the identification lambdas.

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.