doc / ch.tutteli.atrium.api.fluent.en_GB / entriesOf

entriesOf

fun <K, V, T> MapLikeContains.EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>.entriesOf(expectedMapLike: MapLike): Expect<T> (source)

Finishes the specification of the sophisticated contains assertion where the subject (a MapLike) needs to contain all entries of the given expectedMapLike where it does not matter in which order they appear.

Delegates to entries which also means that it does not search for unique matches (see entries for more information).

Notice that a runtime check applies which assures that only Iterable, Sequence or one of the Array types are passed. This function expects MapLike (which is a typealias for Any) to avoid cluttering the API.

Parameters

expectedMapLike - The MapLike whose elements are expected to be contained within this MapLike.

Exceptions

IllegalArgumentException - in case expectedMapLike is not a Map, Sequence or one of the Array types or the given expectedMapLike does not have elements (is empty).

Return
an Expect for the subject of this expectation.

Since
0.15.0

fun <K, V, T> MapLikeContains.EntryPointStep<K, V, T, InAnyOrderOnlySearchBehaviour>.entriesOf(expectedMapLike: MapLike): Expect<T> (source)

Finishes the specification of the sophisticated contains assertion where the subject (a MapLike) needs to contain only and all entries of the given expectedMapLike where it does not matter in which order they appear.

Delegates to entries which also means that it does not search for unique matches (see entries for more information).

Notice that a runtime check applies which assures that only Iterable, Sequence or one of the Array types are passed. This function expects MapLike (which is a typealias for Any) to avoid cluttering the API.

Parameters

expectedMapLike - The MapLike whose elements are expected to be contained within this MapLike.

Exceptions

IllegalArgumentException - in case expectedMapLike is not a Map, Sequence or one of the Array types or the given expectedMapLike does not have elements (is empty).

Return
an Expect for the subject of this expectation.

Since
0.15.0

fun <K, V, T> MapLikeContains.EntryPointStep<K, V, T, InOrderOnlySearchBehaviour>.entriesOf(expectedMapLike: MapLike, report: InOrderOnlyReportingOptions.() -> Unit = {}): Expect<T> (source)

Finishes the specification of the sophisticated contains assertion where the subject (a MapLike) needs to contain only and all entries of the given expectedMapLike in the specified order.

Delegates to entries.

Notice that a runtime check applies which assures that only Map and IterableLike (i.e. Iterable, Sequence or one of the Array types) are passed (this can be changed via MapLikeToIterablePairTransformer and IterableLikeToIterableTransformer). This function expects MapLike (which is a typealias for Any) to avoid cluttering the API.

Exceptions

IllegalArgumentException - in case expectedMapLike is not a Map, Sequence or one of the Array types or the given expectedMapLike does not have elements (is empty).

Parameters

report - The lambda configuring the InOrderOnlyReportingOptions -- it is optional where the default InOrderOnlyReportingOptions apply if not specified. since 0.18.0

Return
an Expect for the subject of this expectation.

Since
0.15.0