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

inAnyOrder

@JvmName("inAnyOrderNullableValues") fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAnyOrder(firstGroup: Group<E>, secondGroup: Group<E>, vararg otherExpectedGroups: Group<E>): AssertionPlant<T>
Deprecated: Switch from api-cc-en_GB to api-fluent-en_GB; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

Finishes the specification of the sophisticated contains assertion where the expected firstGroup as well as the secondGroup and optionally otherExpectedGroups of values need to be contained in Iterable as only elements and in the specified order whereas the values within the groups can occur in any order.

This function will be renamed on a JVM level to inAnyOrder with v1.0.0

Parameters

firstGroup - A group of values which have to appear at first within the Iterable.

secondGroup - A group of values which have to appear after the values of the firstGroup within the Iterable.

otherExpectedGroups - Additional groups of values which are expected to appear after the secondGroup within Iterable whereas the groups have to appear in the given order.

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.

@JvmName("inAnyOrderNullableEntries") fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAnyOrder(firstGroup: Group<(Assert<E>.() -> Unit)?>, secondGroup: Group<(Assert<E>.() -> Unit)?>, vararg otherExpectedGroups: Group<(Assert<E>.() -> Unit)?>): AssertionPlant<T>
Deprecated: Switch from api-cc-en_GB to api-fluent-en_GB; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

Finishes the specification of the sophisticated contains assertion where the expected firstGroup as well as the secondGroup and optionally otherExpectedGroups of identification lambdas, identifying an entry, need to be contained in Iterable as only elements and in the specified order whereas the identification lambdas within the groups can occur in any order.

An identification lambda can also be defined as null in which case it matches an entry which is null as well. Have a look at entries for more information about identification lambdas.

This function will be renamed on a JVM level to inAnyOrderEntries with v1.0.0

Parameters

firstGroup - A group of identification lambdas which have to appear at first within the Iterable.

secondGroup - A group of identification lambdas which have to appear after the values of the firstGroup within the Iterable.

otherExpectedGroups - Additional groups of values which are expected to appear after the secondGroup within Iterable whereas the groups have to appear in the given order.

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>> inAnyOrder(builder: IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>, firstGroup: GroupWithoutNullableEntries<E>, secondGroup: GroupWithoutNullableEntries<E>, vararg otherExpectedGroups: GroupWithoutNullableEntries<E>): AssertionPlant<T>
Deprecated: Use the extension function which expects Group instead; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.


fun <E, T : Iterable<E>> inAnyOrder(builder: IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>, firstGroup: GroupWithNullableEntries<E>, secondGroup: GroupWithNullableEntries<E>, vararg otherExpectedGroups: GroupWithNullableEntries<E>): AssertionPlant<T>
Deprecated: Use the extension function which expects Group instead; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.


@JvmName("inAnyOrderEntries") fun <E : Any, T : Iterable<E>> inAnyOrder(builder: IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>, firstGroup: GroupWithoutNullableEntries<Assert<E>.() -> Unit>, secondGroup: GroupWithoutNullableEntries<Assert<E>.() -> Unit>, vararg otherExpectedGroups: GroupWithoutNullableEntries<Assert<E>.() -> Unit>): AssertionPlant<T>
Deprecated: Use the extension function which expects Group instead; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.


@JvmName("inAnyOrderNullableEntries") fun <E : Any, T : Iterable<E?>> inAnyOrder(builder: IterableContains.Builder<E?, T, InOrderOnlyGroupedWithinSearchBehaviour>, firstGroup: GroupWithNullableEntries<(Assert<E>.() -> Unit)?>, secondGroup: GroupWithNullableEntries<(Assert<E>.() -> Unit)?>, vararg otherExpectedGroups: GroupWithNullableEntries<(Assert<E>.() -> Unit)?>): AssertionPlant<T>
Deprecated: Use the extension function which expects Group instead; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

val <E, T : Iterable<E>> IterableContains.Builder<E, T, NoOpSearchBehaviour>.inAnyOrder: IterableContains.Builder<E, T, InAnyOrderSearchBehaviour>
Deprecated: Switch from api-cc-en_GB to api-fluent-en_GB; will be removed with 1.0.0 -- see https://github.com/robstoll/atrium/releases/tag/v0.9.0#migration for migration hints and scripts.

Defines that the search behaviour "find entries in any order in the Iterable" shall be applied to this sophisticated contains in Iterable assertion.

Return
The newly created builder.