atrium-logic/ch.tutteli.atrium.logic.creating.maplike.contains/MapLikeContains/EntryPointStepInternal

EntryPointStepInternal

interface EntryPointStepInternal<K, V, T : MapLike, out S : MapLikeContains.SearchBehaviour> : MapLikeContains.EntryPointStep<K, V, T, S> , MapLikeContains.EntryPointStepLogic<K, V, T, S> (source)

Sole purpose of this interface is to hide EntryPointStepLogic from newcomers which usually do not have to deal with this type and to keep the API clean.

Moreover, this keeps the API clean and does not pollute it with things like times, containsBuilder etc.

See https://github.com/robstoll/atrium-roadmap/wiki/Requirements#personas for more information about the personas.

Inheritors

EntryPointStepImpl

Properties

_logic

val <K, V, T : Any, S : MapLikeContains.SearchBehaviour> MapLikeContains.EntryPointStep<K, V, T, S>._logic: MapLikeContains.EntryPointStepLogic<K, V, T, S>

Entry point to the logic level of Atrium -- which is one level deeper than the API -- within the building process of a sophisticated contains assertion for Iterable.

andOnly

val <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, InOrderSearchBehaviour>.andOnly: MapLikeContains.EntryPointStep<K, V, T, InOrderOnlySearchBehaviour>

butOnly

val <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, InAnyOrderSearchBehaviour>.butOnly: MapLikeContains.EntryPointStep<K, V, T, InAnyOrderOnlySearchBehaviour>

container

abstract val container: AssertionContainer<T>

The AssertionContainer from which this building process started and to which the resulting Assertion should be appended.

converter

abstract val converter: (T) -> Map<out K, V>

The converter which shall be used to turn the subject of this expectation into an Iterable of type E.

inAnyOrder

val <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, NoOpSearchBehaviour>.inAnyOrder: MapLikeContains.EntryPointStep<K, V, T, InAnyOrderSearchBehaviour>

inOrder

val <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, NoOpSearchBehaviour>.inOrder: MapLikeContains.EntryPointStep<K, V, T, InOrderSearchBehaviour>

searchBehaviour

abstract val searchBehaviour: S

The chosen SearchBehaviour.

Functions

_logicAppend

inline fun <K, V, T : Any, S : MapLikeContains.SearchBehaviour> MapLikeContains.EntryPointStep<K, V, T, S>._logicAppend(factory: MapLikeContains.EntryPointStepLogic<K, V, T, S>.() -> Assertion): Expect<T>

Appends the Assertion the given factory creates based on this MapLikeContains.EntryPointStep.

keyValuePairsInAnyOrder

fun <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, InAnyOrderSearchBehaviour>.keyValuePairsInAnyOrder(keyValuePairs: List<Pair<K, V>>): Assertion

keyValuePairsInAnyOrderOnly

fun <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, InAnyOrderOnlySearchBehaviour>.keyValuePairsInAnyOrderOnly(keyValuePairs: List<Pair<K, V>>): Assertion

keyValuePairsInOrderOnly

fun <K, V, T : MapLike> MapLikeContains.EntryPointStepLogic<K, V, T, InOrderOnlySearchBehaviour>.keyValuePairsInOrderOnly(keyValuePairs: List<Pair<K, V>>, reportingOptions: InOrderOnlyReportingOptions.() -> Unit): Assertion

keyWithValueAssertionsInAnyOrder

fun <K, V : Any, T : MapLike> MapLikeContains.EntryPointStepLogic<K, out V?, T, InAnyOrderSearchBehaviour>.keyWithValueAssertionsInAnyOrder(valueType: KClass<V>, keyValues: List<Pair<K, Expect<V>.() -> Unit?>>): Assertion

keyWithValueAssertionsInAnyOrderOnly

fun <K, V : Any, T : MapLike> MapLikeContains.EntryPointStepLogic<K, out V?, T, InAnyOrderOnlySearchBehaviour>.keyWithValueAssertionsInAnyOrderOnly(valueType: KClass<V>, keyValues: List<Pair<K, Expect<V>.() -> Unit?>>): Assertion

keyWithValueAssertionsInOrderOnly

fun <K, V : Any, T : MapLike> MapLikeContains.EntryPointStepLogic<K, out V?, T, InOrderOnlySearchBehaviour>.keyWithValueAssertionsInOrderOnly(valueType: KClass<V>, keyValues: List<Pair<K, Expect<V>.() -> Unit?>>, reportingOptions: InOrderOnlyReportingOptions.() -> Unit): Assertion

toVarArgPairs

fun <K, V> MapLikeContains.EntryPointStepLogic<*, *, *, *>.toVarArgPairs(mapLike: MapLike): Pair<Pair<K, V>, Array<out Pair<K, V>>>

Transforms the given MapLike to Pair<Pair<K, V>, Array<out Pair<K, V>>> with the intention that it can be easily used for a function requiring Pair<K, V>, vararg Pair<K, V>.

withSearchBehaviour

open fun <S2 : MapLikeContains.SearchBehaviour> withSearchBehaviour(searchBehaviour: S2): MapLikeContains.EntryPointStep<K, V, T, S2>