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

Package ch.tutteli.atrium.api.cc.infix.en_GB

@Depreacted API use ch.tutteli.atrium.api.infix.en_GB instead.

Types

All

class All<out T> : VarArgHelper<T>

Parameter object to express T, vararg T in the infix-api.

Entries

class Entries<in T : Any> : GroupWithoutNullableEntries<(Assert<T>.() -> Unit)?>, GroupWithNullableEntries<(Assert<T>.() -> Unit)?>, VarArgHelper<(Assert<T>.() -> Unit)?>

Parameter object to express a Group of identification lambdas.

Entry

class Entry<in T : Any> : GroupWithoutNullableEntries<(Assert<T>.() -> Unit)?>, GroupWithNullableEntries<(Assert<T>.() -> Unit)?>

Parameter object to express a Group with a single identification lambda.

Index

data class Index

Wrapper for a single index -- can be used as distinguishable type for an overload where Int is already in use.

Key

data class Key<out K>

Wrapper for a single key -- can be used as distinguishable type for an overload where K is already in use.

KeyNullableValue

data class KeyNullableValue<out K, V : Any>

KeyValue

data class KeyValue<out K, V : Any>

Parameter object to express a key/value Pair whose value type is a lambda with an Assert receiver, which means one can either pass a lambda or null.

NullableEntries

class NullableEntries<T : Any> : GroupWithNullableEntries<(Assert<T>.() -> Unit)?>

NullableEntry

class NullableEntry<T : Any> : GroupWithNullableEntries<(Assert<T>.() -> Unit)?>

NullableValue

data class NullableValue<T> : GroupWithNullableEntries<T>

NullableValues

class NullableValues<T> : GroupWithNullableEntries<T>

Order

class Order<out T, out G : Group<T>>

Parameter object to express Group<T>, Group<T>, vararg Group<T> in the infix-api.

Pairs

class Pairs<out K, out V> : VarArgHelper<Pair<K, V>>

Parameter object to express Pair<K, V>, vararg Pair<K, V> in the infix-api.

RegexPatterns

class RegexPatterns : VarArgHelper<String>

Parameter object to express String, vararg String in the infix-api.

Value

data class Value<out T> : GroupWithNullableEntries<T>, GroupWithoutNullableEntries<T>

Represents a Group with a single value.

Values

class Values<out T> : GroupWithoutNullableEntries<T>, GroupWithNullableEntries<T>, VarArgHelper<T>

Represents a Group of multiple values.

Properties

first

val <K : Any> Assert<Pair<K, *>>.first: Assert<K>

Creates an AssertionPlant for the Assert.subject's property first so that further fluent calls are assertions about it.

key

val <K : Any> Assert<Entry<K, *>>.key: Assert<K>

Creates an AssertionPlant for the Assert.subject's property key so that further fluent calls are assertions about it.

keys

val <K, V> Assert<Map<out K, V>>.keys: Assert<Set<K>>

Creates an AssertionPlant for the Assert.subject's property keys so that further fluent calls are assertions about it.

o

val <T : Any> Assert<T>.o: Assert<T>

Inline property referring actually to this and allows to write nicer sub-assertions.

second

val <V : Any> Assert<Pair<*, V>>.second: Assert<V>

Creates an AssertionPlant for the Assert.subject's property second so that further fluent calls are assertions about it.

size

val Assert<Collection<*>>.size: Assert<Int>

Creates an AssertionPlant for the Assert.subject's property size so that further fluent calls are assertions about it.

value

val <V : Any> Assert<Entry<*, V>>.value: Assert<V>

Creates an AssertionPlant for the Assert.subject's property value so that further fluent calls are assertions about it.

values

val <K, V> Assert<Map<out K, V>>.values: Assert<Collection<V>>

Creates an AssertionPlant for the Assert.subject's property values so that further fluent calls are assertions about it.

Functions

all

infix fun <E : Any, T : Iterable<E?>> Assert<T>.all(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Makes the assertion that the Assert.subject has at least one element and that every element holds all assertions created by the assertionCreatorOrNull or that all elements are null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.all(nullableEntry: NullableEntry<E>): AssertionPlant<T>

and

infix fun <T : Any> AssertionPlant<T>.and(assertionCreator: Assert<T>.() -> Unit): AssertionPlant<T>

Can be used to create a group of sub assertions when using the fluent API.

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderSearchBehaviour>.and(only: only): IterableContains.Builder<E, T, InOrderOnlySearchBehaviour>

Defines that the constraint "only the specified entries exist in the Iterable" shall be applied to this sophisticated contains in order Iterable assertion.

any

infix fun <E : Any, T : Iterable<E?>> Assert<T>.any(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Makes the assertion that the Assert.subject contains an entry holding the assertions created by the assertionCreatorOrNull or an entry which is null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.any(nullableEntry: NullableEntry<E>): AssertionPlant<T>

asEntries

fun <K, V> Assert<Map<out K, V>>.asEntries(): Assert<Set<Entry<K, V>>>

Turns Assert<Map<out K, V>> into Assert<Set<Map.Entry<K, V>>>.

infix fun <K, V> Assert<Map<out K, V>>.asEntries(assertionCreator: Assert<Set<Entry<K, V>>>.() -> Unit): Assert<Set<Entry<K, V>>>

Turns Assert<Map<out K, V>> into Assert<Set<Map.Entry<K, V>>> and makes the assertion that the assertions the given assertionCreator might create hold.

asIterable

fun <E> Assert<Array<out E>>.asIterable(): Assert<Iterable<E>>

Turns Assert<Array<E>> into Assert<Iterable<E>>.

infix fun <E> Assert<Array<out E>>.asIterable(assertionCreator: Assert<Iterable<E>>.() -> Unit): Assert<Iterable<E>>

Turns Assert<Array<E>> into Assert<Iterable<E>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<ByteArray>.asIterable(): Assert<Iterable<Byte>>

Turns Assert<CharArray> into Assert<Iterable<Byte>>.

infix fun Assert<ByteArray>.asIterable(assertionCreator: Assert<Iterable<Byte>>.() -> Unit): Assert<Iterable<Byte>>

Turns Assert<CharArray> into Assert<Iterable<Byte>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<CharArray>.asIterable(): Assert<Iterable<Char>>

Turns Assert<CharArray> into Assert<Iterable<Char>>.

infix fun Assert<CharArray>.asIterable(assertionCreator: Assert<Iterable<Char>>.() -> Unit): Assert<Iterable<Char>>

Turns Assert<CharArray> into Assert<Iterable<Char>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<ShortArray>.asIterable(): Assert<Iterable<Short>>

Turns Assert<ShortArray> into Assert<Iterable<Short>>.

infix fun Assert<ShortArray>.asIterable(assertionCreator: Assert<Iterable<Short>>.() -> Unit): Assert<Iterable<Short>>

Turns Assert<ShortArray> into Assert<Iterable<Short>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<IntArray>.asIterable(): Assert<Iterable<Int>>

Turns Assert<IntArray> into Assert<Iterable<Int>>.

infix fun Assert<IntArray>.asIterable(assertionCreator: Assert<Iterable<Int>>.() -> Unit): Assert<Iterable<Int>>

Turns Assert<IntArray> into Assert<Iterable<Int>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<LongArray>.asIterable(): Assert<Iterable<Long>>

Turns Assert<LongArray> into Assert<Iterable<Double>>.

infix fun Assert<LongArray>.asIterable(assertionCreator: Assert<Iterable<Long>>.() -> Unit): Assert<Iterable<Long>>

Turns Assert<LongArray> into Assert<Iterable<Double>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<FloatArray>.asIterable(): Assert<Iterable<Float>>

Turns Assert<FloatArray> into Assert<Iterable<Float>>.

infix fun Assert<FloatArray>.asIterable(assertionCreator: Assert<Iterable<Float>>.() -> Unit): Assert<Iterable<Float>>

Turns Assert<FloatArray> into Assert<Iterable<Float>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<DoubleArray>.asIterable(): Assert<Iterable<Double>>

Turns Assert<DoubleArray> into Assert<Iterable<Double>>.

infix fun Assert<DoubleArray>.asIterable(assertionCreator: Assert<Iterable<Double>>.() -> Unit): Assert<Iterable<Double>>

Turns Assert<DoubleArray> into Assert<Iterable<Double>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun Assert<BooleanArray>.asIterable(): Assert<Iterable<Boolean>>

Turns Assert<BooleanArray> into Assert<Iterable<Boolean>>.

infix fun Assert<BooleanArray>.asIterable(assertionCreator: Assert<Iterable<Boolean>>.() -> Unit): Assert<Iterable<Boolean>>

Turns Assert<BooleanArray> into Assert<Iterable<Boolean>> and makes the assertion that the assertions the given assertionCreator might create hold.

fun <E> Assert<Sequence<E>>.asIterable(): Assert<Iterable<E>>

Turns Assert<Sequence<E>> into Assert<Iterable<E>>.

atLeast

infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.Builder<T, S>.atLeast(times: Int): AtLeastCheckerOption<T, S>

Restricts a contains assertion by specifying that the number of occurrences of the value which we are looking for occurs at least number of times within the search input.

infix fun <E, T : Iterable<E>, S : InAnyOrderSearchBehaviour> IterableContains.Builder<E, T, S>.atLeast(times: Int): AtLeastCheckerOption<E, T, S>

Restricts a contains assertion by specifying that the number of occurrences of the entry which we are looking for occurs at least number of times within the Iterable.

atMost

infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.Builder<T, S>.atMost(times: Int): AtMostCheckerOption<T, S>

Restricts a contains assertion by specifying that the number of occurrences of the value which we are looking for occurs at least once but at most number of times within the search input.

infix fun <E, T : Iterable<E>, S : InAnyOrderSearchBehaviour> IterableContains.Builder<E, T, S>.atMost(times: Int): AtMostCheckerOption<E, T, S>

Restricts a contains assertion by specifying that the number of occurrences of the entry which we are looking for occurs at least once but at most number of times within the Iterable.

but

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InAnyOrderSearchBehaviour>.but(only: only): IterableContains.Builder<E, T, InAnyOrderOnlySearchBehaviour>

Defines that the constraint "only the specified entries exist in the Iterable" shall be applied to this sophisticated contains Iterable assertion.

butAtMost

infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> AtLeastCheckerOption<T, S>.butAtMost(times: Int): ButAtMostCheckerOption<T, S>

Restricts a contains at least assertion by specifying that the number of occurrences of the value which we are looking for occurs at most number of times within the search input.

infix fun <E, T : Iterable<E>, S : InAnyOrderSearchBehaviour> AtLeastCheckerOption<E, T, S>.butAtMost(times: Int): ButAtMostCheckerOption<E, T, S>

Restricts a contains at least assertion by specifying that the number of occurrences of the entry which we are looking for occurs at most number of times within the Iterable.

contains

infix fun <T : CharSequence> Assert<T>.contains(expected: Any): AssertionPlant<T>

Makes the assertion that the Assert.subject contains the toString representation of the given expected using a non disjoint search.

infix fun <T : CharSequence> Assert<T>.contains(values: Values<Any>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains the given values representation using a non disjoint search.

infix fun <T : CharSequence> Assert<T>.contains(patterns: RegexPatterns): AssertionPlant<T>

Makes the assertion that the Assert.subject contains a sequence which matches the given patterns using a non disjoint search.

infix fun <E, T : Iterable<E>> Assert<T>.contains(expected: E): AssertionPlant<T>

Makes the assertion that the Assert.subject contains the expected value.

infix fun <E, T : Iterable<E>> Assert<T>.contains(values: Values<E>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains the expected values.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.contains(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Makes the assertion that the Assert.subject contains an entry holding the assertions created by assertionCreatorOrNull or an entry which is null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.contains(entries: Entries<E>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains an entry holding the assertions created by entries.assertionCreatorOrNull or an entry which is null in case entries.assertionCreatorOrNull is defined as null -- likewise an entry (can be the same) is searched for each of the entries.otherAssertionCreatorsOrNulls.

infix fun <K, V, T : Map<out K, V>> Assert<T>.contains(keyValuePair: Pair<K, V>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains a key as defined by keyValuePair's Pair.first with a corresponding value as defined by keyValuePair's Pair.second.

infix fun <K, V, T : Map<out K, V>> Assert<T>.contains(keyValuePairs: Pairs<K, V>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains for each entry in keyValuePairs, a key as defined by entry's Pair.first with a corresponding value as defined by entry's Pair.second.

infix fun <K, V : Any, T : Map<out K, V?>> Assert<T>.contains(keyValue: KeyValue<K, V>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains a key as defined by keyValue's KeyValue.key with a corresponding value which either holds all assertions keyValue's KeyValue.valueAssertionCreatorOrNull might create or needs to be null in case KeyValue.valueAssertionCreatorOrNull is defined as null.

infix fun <K, V : Any, T : Map<out K, V?>> Assert<T>.contains(keyValues: All<KeyValue<K, V>>): AssertionPlant<T>

Makes the assertion that for each of the KeyValue in keyValues, the Assert.subject contains a key as defined by keyValue's KeyValue.key with a corresponding value which either holds all assertions keyValue's KeyValue.valueAssertionCreatorOrNull might create or needs to be null in case KeyValue.valueAssertionCreatorOrNull is defined as null.

infix fun <E, T : Iterable<E>> Assert<T>.contains(nullableValue: NullableValue<E>): AssertionPlant<T>
infix fun <E, T : Iterable<E>> Assert<T>.contains(nullableValues: NullableValues<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> Assert<T>.contains(nullableEntry: NullableEntry<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> Assert<T>.contains(nullableEntries: NullableEntries<E>): AssertionPlant<T>

containsExactly

infix fun <E, T : Iterable<E>> Assert<T>.containsExactly(expected: E): AssertionPlant<T>

Makes the assertion that the Assert.subject contains only the expected value.

infix fun <E, T : Iterable<E>> Assert<T>.containsExactly(values: Values<E>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains only the expected values in the defined order.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.containsExactly(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Makes the assertion that the Assert.subject contains only one entry which is holding the assertions created by assertionCreatorOrNull or only one entry which is null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.containsExactly(entries: Entries<E>): AssertionPlant<T>

Makes the assertion that the Assert.subject contains only an entry holding the assertions created by entries.assertionCreatorOrNull or null in case entries.assertionCreatorOrNull is defined as null and likewise an additional entry for each entries.otherAssertionCreatorsOrNulls (if given) whereas the entries have to appear in the defined order.

containsKey

infix fun <K> Assert<Map<out K, *>>.containsKey(key: K): AssertionPlant<Map<out K, *>>

Makes the assertion that the Assert.subject contains the given key.

containsNot

infix fun <T : CharSequence> Assert<T>.containsNot(expected: Any): AssertionPlant<T>

Makes the assertion that the Assert.subject does not expected's toString representation.

infix fun <T : CharSequence> Assert<T>.containsNot(values: Values<Any>): AssertionPlant<T>

Makes the assertion that the Assert.subject does not contain the toString representation of the given values.

infix fun <E, T : Iterable<E>> Assert<T>.containsNot(expected: E): AssertionPlant<T>

Makes the assertion that the Assert.subject does not contain the expected value.

infix fun <E, T : Iterable<E>> Assert<T>.containsNot(values: Values<E>): AssertionPlant<T>

Makes the assertion that the Assert.subject does not contain the expected values.

containsNotKey

infix fun <K> Assert<Map<out K, *>>.containsNotKey(key: K): AssertionPlant<Map<out K, *>>

Makes the assertion that the Assert.subject does not contain the given key.

containsRegex

infix fun <T : CharSequence> Assert<T>.containsRegex(pattern: String): AssertionPlant<T>

Makes the assertion that the Assert.subject contains a sequence which matches the given pattern.

containsStrictly

infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(expected: E): AssertionPlant<T>
infix fun <E, T : Iterable<E>> Assert<T>.containsStrictly(expected: NullableValue<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(values: Values<E>): AssertionPlant<T>
infix fun <E, T : Iterable<E>> Assert<T>.containsStrictly(nullableValues: NullableValues<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> Assert<T>.containsStrictly(nullableEntry: NullableEntry<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(entries: Entries<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> Assert<T>.containsStrictly(nullableEntries: NullableEntries<E>): AssertionPlant<T>

endsNotWith

infix fun <T : CharSequence> Assert<T>.endsNotWith(expected: CharSequence): AssertionPlant<T>

Makes the assertion that the Assert.subject does not end with expected.

endsWith

infix fun <T : CharSequence> Assert<T>.endsWith(expected: CharSequence): AssertionPlant<T>

Makes the assertion that the Assert.subject ends with expected.

entry

infix fun <E : Any, T : Iterable<E?>> IterableContains.CheckerOption<E?, T, InAnyOrderSearchBehaviour>.entry(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where an entry shall be searched which either holds all assertions assertionCreatorOrNull might create or needs to be null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InAnyOrderOnlySearchBehaviour>.entry(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable must contain only one entry which holds all assertions created by the given assertionCreatorOrNull or has to be null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InOrderOnlySearchBehaviour>.entry(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable needs to contain only a single entry which holds all assertions created by the given assertionCreatorOrNull or needs to be null in case assertionCreatorOrNull is defined as null.

exactly

infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.Builder<T, S>.exactly(times: Int): ExactlyCheckerOption<T, S>

Restricts a contains assertion by specifying that the number of occurrences of the value which we are looking for occurs exactly number of times within the search input.

infix fun <E, T : Iterable<E>, S : InAnyOrderSearchBehaviour> IterableContains.Builder<E, T, S>.exactly(times: Int): ExactlyCheckerOption<E, T, S>

Restricts a contains assertion by specifying that the number of occurrences of the entry which we are looking for occurs exactly number of times within the Iterable.

first

infix fun <K : Any, V> Assert<Pair<K, V>>.first(assertionCreator: Assert<K>.() -> Unit): AssertionPlant<Pair<K, V>>

Makes the assertion that the Assert.subject's property first holds all assertions the given assertionCreator might create for it.

get

infix fun <E : Any, T : List<E>> Assert<T>.get(index: Int): AssertionPlant<E>

Makes the assertion that the given index is within the bounds of Assert.subject, creates a feature assertion plant for the corresponding element and returns the newly created plant.

infix fun <E : Any, T : List<E>> Assert<T>.get(index: Index): ListGetOption<E, T>

Prepares the assertion about the return value of calling get with the given index.

getExisting

infix fun <K, V : Any, T : Map<out K, V>> Assert<T>.getExisting(key: K): Assert<V>

Makes the assertion that the Assert.subject contains the given key, creates a feature assertion plant for the corresponding value and returns the newly created plant.

infix fun <K, V : Any, T : Map<out K, V>> Assert<T>.getExisting(key: Key<K>): MapGetOption<K, V, T>

Prepares the assertion about the return value of calling get with the given key.

grouped

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlySearchBehaviour>.grouped(entries: entries): IterableContains.Builder<E, T, InOrderOnlyGroupedSearchBehaviour>

Defines that the Iterable contains groups of entries in order only where the entries within the group can be in any order.

hasSize

infix fun <T : Collection<*>> Assert<T>.hasSize(size: Int): AssertionPlant<T>

Makes the assertion that the Assert.subject's Collection.size is size.

ignoring

infix fun <T : CharSequence> CharSequenceContains.Builder<T, NoOpSearchBehaviour>.ignoring(case: case): CharSequenceContains.Builder<T, IgnoringCaseSearchBehaviour>

Defines that the search behaviour ignore case shall be applied to this sophisticated contains assertion.

infix fun <T : CharSequence> NotCheckerOption<T, NotSearchBehaviour>.ignoring(case: case): NotCheckerOption<T, IgnoringCaseSearchBehaviour>

Defines that the search behaviour ignore case shall be applied to this sophisticated contains not assertion.

inAny

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAny(order: Order<E, Group<E>>): AssertionPlant<T>

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

infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAny(order: Order<(Assert<E>.() -> Unit)?, Group<(Assert<E>.() -> Unit)?>>): AssertionPlant<T>

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

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, NoOpSearchBehaviour>.inAny(order: order): IterableContains.Builder<E, T, InAnyOrderSearchBehaviour>

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

fun <E, T : Iterable<E>> inAny(builder: IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>, order: Order<E, GroupWithNullableEntries<E>>): AssertionPlant<T>
fun <E : Any, T : Iterable<E?>> inAny(builder: IterableContains.Builder<E?, T, InOrderOnlyGroupedWithinSearchBehaviour>, order: Order<(Assert<E>.() -> Unit)?, GroupWithNullableEntries<(Assert<E>.() -> Unit)?>>): AssertionPlant<T>

inGiven

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, NoOpSearchBehaviour>.inGiven(order: order): IterableContains.Builder<E, T, InOrderSearchBehaviour>

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

isA

infix fun <TSub : Any> Assert<Any>.isA(assertionCreator: AssertionPlant<TSub>.() -> Unit): Unit

Makes the assertion that the Assert.subject is a TSub (the same type or a sub-type) and if so, uses assertionCreator which could create further assertions which are added as a group.

isEqualIncludingScale

infix fun <T : BigDecimal> Assert<T>.isEqualIncludingScale(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is (equal to) expected including BigDecimal.scale.

isGreaterOrEquals

infix fun <T : Comparable<T>> Assert<T>.isGreaterOrEquals(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is greater than or equals expected.

isGreaterThan

infix fun <T : Comparable<T>> Assert<T>.isGreaterThan(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is greater than expected.

isKeyValue

infix fun <K : Any, V : Any> Assert<Entry<K, V>>.isKeyValue(keyValuePair: Pair<K, V>): Assert<Entry<K, V>>

Makes the assertion that the Assert.subject's Map.Entry.key is (equal to) the given Pair.first and Map.Entry.value is Pair.second.

isLessOrEquals

infix fun <T : Comparable<T>> Assert<T>.isLessOrEquals(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is less than or equals expected.

isLessThan

infix fun <T : Comparable<T>> Assert<T>.isLessThan(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is less than expected.

isNotEqualIncludingScale

infix fun <T : BigDecimal> Assert<T>.isNotEqualIncludingScale(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is not equal to expected including BigDecimal.scale.

isNotNumericallyEqualTo

infix fun <T : BigDecimal> Assert<T>.isNotNumericallyEqualTo(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is not numerically equal to expected.

isNotSameAs

infix fun <T : Any> Assert<T>.isNotSameAs(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is not the same instance as expected.

isNumericallyEqualTo

infix fun <T : BigDecimal> Assert<T>.isNumericallyEqualTo(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is numerically equal to expected.

isSameAs

infix fun <T : Any> Assert<T>.isSameAs(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is the same instance as expected.

key

infix fun <K : Any, V> Assert<Entry<K, V>>.key(assertionCreator: Assert<K>.() -> Unit): AssertionPlant<Entry<K, V>>

Makes the assertion that the Assert.subject's property key holds all assertions the given assertionCreator might create for it.

keys

infix fun <K, V, T : Map<out K, V>> Assert<T>.keys(assertionCreator: Assert<Set<K>>.() -> Unit): AssertionPlant<T>

Makes the assertion that the Assert.subject's property keys holds all assertions the given assertionCreator might create.

message

infix fun <T : Throwable> Assert<T>.message(assertionCreator: Assert<String>.() -> Unit): Unit

Creates an AssertionPlantNullable for the message of the plant's subject (which is a Throwable) and makes the assertion that the message ought notToBeNull and uses assertionCreator which might create further Assertions which are lazily evaluated at the end.

messageContains

infix fun <T : Throwable> Assert<T>.messageContains(expected: Any): Unit

Creates the assertion that the Throwable's message is not null (see message) and contains the toString representation of the given expected using a non disjoint search.

infix fun <T : Throwable> Assert<T>.messageContains(values: Values<Any>): Unit

Creates the assertion that the Throwable's message is not null (see message) and contains the toString representation of the given values using a non disjoint search.

none

infix fun <E : Any, T : Iterable<E?>> Assert<T>.none(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

Makes the assertion that the Assert.subject does not contain a single entry which holds all assertions created by assertionCreatorOrNull or does not contain a single entry which is null in case assertionCreatorOrNull is defined as null.

infix fun <E : Any, T : Iterable<E?>> Assert<T>.none(nullableEntry: NullableEntry<E>): AssertionPlant<T>

notOrAtMost

infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.Builder<T, S>.notOrAtMost(times: Int): NotOrAtMostCheckerOption<T, S>

Restricts a contains assertion by specifying that the number of occurrences of the value which we are looking for occurs not at all or at most number of times within the search input.

infix fun <E, T : Iterable<E>, S : InAnyOrderSearchBehaviour> IterableContains.Builder<E, T, S>.notOrAtMost(times: Int): NotOrAtMostCheckerOption<E, T, S>

Restricts a contains assertion by specifying that the number of occurrences of the entry which we are looking for occurs not at all or at most number of times within the Iterable.

notTo

infix fun <T : CharSequence> Assert<T>.notTo(contain: contain): NotCheckerOption<T, NotSearchBehaviour>

Creates a CharSequenceContains.Builder based on this AssertionPlant which allows to define more sophisticated contains not assertions.

notToBe

infix fun <T : Any> Assert<T>.notToBe(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is not (equal to) expected.

infix fun <T : Any> Assert<T>.notToBe(keyword: Keyword): Nothinginfix fun <T : CharSequence> Assert<T>.notToBe(Empty: Empty): AssertionPlant<T>

Makes the assertion that the Assert.subject CharSequence.kotlin.text.isNotEmpty.

infix fun <T : CharSequence> Assert<T>.notToBe(Blank: Blank): AssertionPlant<T>

Makes the assertion that the Assert.subject CharSequence.kotlin.text.isNotBlank.

notToBeNull

infix fun <T : Any> AssertionPlantNullable<T?>.notToBeNull(assertionCreator: Assert<T>.() -> Unit): Unit

Makes the assertion that AssertionPlantNullable.subject is not null and if so, uses assertionCreator which could create further assertions which are added as a group.

notToBeNullBut

infix fun <T : BigDecimal> AssertionPlantNullable<T?>.notToBeNullBut(expected: T): Nothing
infix fun <T : Any> AssertionPlantNullable<T>.notToBeNullBut(keyword: Keyword): Nothing

notToThrow

fun ThrowableThrown.Builder.notToThrow(): Unit

Makes the assertion that no Throwable is thrown at all.

nullableEntry

infix fun <E : Any, T : Iterable<E?>> IterableContains.CheckerOption<E?, T, InAnyOrderSearchBehaviour>.nullableEntry(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InAnyOrderOnlySearchBehaviour>.nullableEntry(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InOrderOnlySearchBehaviour>.nullableEntry(assertionCreatorOrNull: (Assert<E>.() -> Unit)?): AssertionPlant<T>

nullableValue

infix fun <E, T : Iterable<E>> IterableContains.CheckerOption<E, T, InAnyOrderSearchBehaviour>.nullableValue(expectedOrNull: E): AssertionPlant<T>
infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InAnyOrderOnlySearchBehaviour>.nullableValue(expectedOrNull: E): AssertionPlant<T>
infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlySearchBehaviour>.nullableValue(expectedOrNull: E): AssertionPlant<T>

property

fun <T : Any, TProperty : Any> Assert<T>.property(property: KProperty0<TProperty>): AssertionPlant<TProperty>
fun <T : Any, TProperty : Any> Assert<T>.property(property: KProperty1<T, TProperty>): AssertionPlant<TProperty>

Creates an AssertionPlant for the given property which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the given property, to the current plant.

fun <T : Any, TProperty : Any> CollectingAssertionPlant<T>.property(property: KProperty0<TProperty>): AssertionPlant<TProperty>
fun <T : Any, TProperty : Any> CollectingAssertionPlant<T>.property(property: KProperty0<TProperty>, assertionCreator: Assert<TProperty>.() -> Unit): AssertionPlant<TProperty>fun <T : Any, TProperty : Any> Assert<T>.property(property: KProperty0<TProperty>, assertionCreator: Assert<TProperty>.() -> Unit): AssertionPlant<TProperty>
fun <T : Any, TProperty : Any> Assert<T>.property(property: KProperty1<T, TProperty>, assertionCreator: Assert<TProperty>.() -> Unit): AssertionPlant<TProperty>

Creates an AssertionPlant for the given property which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the given property, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

regex

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, NoOpSearchBehaviour>.regex(pattern: String): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression pattern is expected to have a match, using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, IgnoringCaseSearchBehaviour>.regex(pattern: String): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression pattern is expected to have a match (ignoring case), using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.Builder<T, IgnoringCaseSearchBehaviour>.regex(pattern: String): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression pattern is expected to have at least one match (ignoring case), using a non disjoint search.

returnValueOf

fun <T : Any, R : Any> Assert<T>.returnValueOf(method: KFunction0<R>): AssertionPlant<R>
fun <T : Any, R : Any> Assert<T>.returnValueOf(method: KFunction1<T, R>): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

fun <T : Any, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction0<R>): AssertionPlant<R>
fun <T : Any, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction0<R>, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction1<T1, R>, arg1: T1): AssertionPlant<R>
fun <T : Any, T1, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction1<T1, R>, arg1: T1, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction2<T1, T2, R>, arg1: T1, arg2: T2): AssertionPlant<R>
fun <T : Any, T1, T2, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction2<T1, T2, R>, arg1: T1, arg2: T2, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, T3, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<R>
fun <T : Any, T1, T2, T3, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, T5, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, T5, R : Any> CollectingAssertionPlant<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>fun <T : Any, R : Any> Assert<T>.returnValueOf(method: KFunction0<R>, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, R : Any> Assert<T>.returnValueOf(method: KFunction1<T, R>, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

fun <T : Any, T1, R : Any> Assert<T>.returnValueOf(method: KFunction1<T1, R>, arg1: T1): AssertionPlant<R>
fun <T : Any, T1, R : Any> Assert<T>.returnValueOf(method: KFunction2<T, T1, R>, arg1: T1): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

fun <T : Any, T1, R : Any> Assert<T>.returnValueOf(method: KFunction1<T1, R>, arg1: T1, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, R : Any> Assert<T>.returnValueOf(method: KFunction2<T, T1, R>, arg1: T1, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

fun <T : Any, T1, T2, R : Any> Assert<T>.returnValueOf(method: KFunction2<T1, T2, R>, arg1: T1, arg2: T2): AssertionPlant<R>
fun <T : Any, T1, T2, R : Any> Assert<T>.returnValueOf(method: KFunction3<T, T1, T2, R>, arg1: T1, arg2: T2): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1 and arg2, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

fun <T : Any, T1, T2, R : Any> Assert<T>.returnValueOf(method: KFunction2<T1, T2, R>, arg1: T1, arg2: T2, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, R : Any> Assert<T>.returnValueOf(method: KFunction3<T, T1, T2, R>, arg1: T1, arg2: T2, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1 and arg2, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

fun <T : Any, T1, T2, T3, R : Any> Assert<T>.returnValueOf(method: KFunction3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<R>
fun <T : Any, T1, T2, T3, R : Any> Assert<T>.returnValueOf(method: KFunction4<T, T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2 and arg3, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

fun <T : Any, T1, T2, T3, R : Any> Assert<T>.returnValueOf(method: KFunction3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, T3, R : Any> Assert<T>.returnValueOf(method: KFunction4<T, T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2 and arg3, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

fun <T : Any, T1, T2, T3, T4, R : Any> Assert<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, R : Any> Assert<T>.returnValueOf(method: KFunction5<T, T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3 and arg4, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

fun <T : Any, T1, T2, T3, T4, R : Any> Assert<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, R : Any> Assert<T>.returnValueOf(method: KFunction5<T, T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3 and arg4, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

fun <T : Any, T1, T2, T3, T4, T5, R : Any> Assert<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, T5, R : Any> Assert<T>.returnValueOf(method: KFunction6<T, T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3, arg4 and arg5, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

fun <T : Any, T1, T2, T3, T4, T5, R : Any> Assert<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>
fun <T : Any, T1, T2, T3, T4, T5, R : Any> Assert<T>.returnValueOf(method: KFunction6<T, T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: Assert<R>.() -> Unit): AssertionPlant<R>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3, arg4 and arg5, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

second

infix fun <K, V : Any> Assert<Pair<K, V>>.second(assertionCreator: Assert<V>.() -> Unit): AssertionPlant<Pair<K, V>>

Makes the assertion that the Assert.subject's property second holds all assertions the given assertionCreator might create for it.

size

infix fun <E, T : Collection<E>> Assert<T>.size(assertionCreator: Assert<Int>.() -> Unit): Assert<T>

Makes the assertion that the Assert.subject's property size holds all assertions the given assertionCreator might create for it.

startsNotWith

infix fun <T : CharSequence> Assert<T>.startsNotWith(expected: CharSequence): AssertionPlant<T>

Makes the assertion that the Assert.subject does not start with expected.

startsWith

infix fun <T : CharSequence> Assert<T>.startsWith(expected: CharSequence): AssertionPlant<T>

Makes the assertion that the Assert.subject starts with expected.

the

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, NoOpSearchBehaviour>.the(values: Values<Any>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given values shall be searched, using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, IgnoringCaseSearchBehaviour>.the(values: Values<Any>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the values shall be searched (ignoring case), using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.Builder<T, IgnoringCaseSearchBehaviour>.the(values: Values<Any>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the values shall be searched (ignoring case), using a non disjoint search where each need to be contained at least once.

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, NoOpSearchBehaviour>.the(patterns: RegexPatterns): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression patterns are expected to have a match, using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, IgnoringCaseSearchBehaviour>.the(patterns: RegexPatterns): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression patterns are expected to have a match (ignoring case), using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.Builder<T, IgnoringCaseSearchBehaviour>.the(patterns: RegexPatterns): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression patterns are expected to have at least one match (ignoring case), using a non disjoint search.

infix fun <E, T : Iterable<E>> IterableContains.CheckerOption<E, T, InAnyOrderSearchBehaviour>.the(values: Values<E>): AssertionPlant<T>

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

infix fun <E : Any, T : Iterable<E?>> IterableContains.CheckerOption<E?, T, InAnyOrderSearchBehaviour>.the(entries: Entries<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where an entry shall be searched which either holds all assertions entries.assertionCreatorOrNull might create or needs to be null in case entries.assertionCreatorOrNull is defined as null -- likewise an entry (can be the same) is searched for each of the entries.otherAssertionCreatorsOrNulls.

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InAnyOrderOnlySearchBehaviour>.the(values: Values<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected values must be contained in Iterable but it does not matter in which order.

infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InAnyOrderOnlySearchBehaviour>.the(entries: Entries<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where an entry needs to be contained in the Iterable which holds all assertions entries.assertionCreatorOrNull might create or it needs to be null in case entries.assertionCreatorOrNull is defined as null -- likewise an entry for each entries.otherAssertionCreatorsOrNulls 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.

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlySearchBehaviour>.the(values: Values<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable needs to contain only the expected values in the specified order.

infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InOrderOnlySearchBehaviour>.the(entries: Entries<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable needs to contain only an entry which holds all assertions entries.assertionCreatorOrNull might create or is null in case entries.assertionCreatorOrNull is defined as null and likewise a further entry for each entries.otherAssertionCreatorsOrNulls (if given) whereas the entries have to appear in the specified order.

infix fun <E, T : Iterable<E>> IterableContains.CheckerOption<E, T, InAnyOrderSearchBehaviour>.the(nullableValues: NullableValues<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> IterableContains.CheckerOption<E?, T, InAnyOrderSearchBehaviour>.the(nullableEntries: NullableEntries<E>): AssertionPlant<T>
infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InAnyOrderOnlySearchBehaviour>.the(nullableValues: NullableValues<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InAnyOrderOnlySearchBehaviour>.the(nullableEntries: NullableEntries<E>): AssertionPlant<T>
infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlySearchBehaviour>.the(nullableValues: NullableValues<E>): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E?>> IterableContains.Builder<E?, T, InOrderOnlySearchBehaviour>.the(nullableEntries: NullableEntries<E>): AssertionPlant<T>

to

infix fun <T : CharSequence> Assert<T>.to(contain: contain): CharSequenceContains.Builder<T, NoOpSearchBehaviour>

Creates a CharSequenceContains.Builder based on this AssertionPlant which allows to define a sophisticated contains assertions.

toBe

infix fun <T : Any> Assert<T>.toBe(expected: T): AssertionPlant<T>

Makes the assertion that the Assert.subject is (equal to) expected.

infix fun <T : Any> Assert<T>.toBe(keyword: Keyword): Nothing
fun <T> toBe(plant: AssertionPlantNullable<T>, void: Void?): Unitinfix fun <T : Any> AssertionPlantNullable<T?>.toBe(expected: T?): Unit

Makes the assertion that the Assert.subject is expected.

infix fun <T : CharSequence> Assert<T>.toBe(Empty: Empty): AssertionPlant<T>

Makes the assertion that the Assert.subject CharSequence.kotlin.text.isEmpty.

toBeNullIfNullGivenElse

infix fun <T : Any> AssertionPlantNullable<T?>.toBeNullIfNullGivenElse(assertionCreatorOrNull: (Assert<T>.() -> Unit)?): Unit

Makes the assertion that the Assert.subject is either null if assertionCreatorOrNull is null or is not null and holds all assertions assertionCreatorOrNull might create.

toThrow

infix fun <TExpected : Throwable> ThrowableThrown.Builder.toThrow(assertionCreator: Assert<TExpected>.() -> Unit): Unit

Makes the assertion that the thrown Throwable is of type TExpected and holds all assertions the assertionCreator might create in addition.

value

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, NoOpSearchBehaviour>.value(expected: Any): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected object shall be searched, using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.CheckerOption<T, IgnoringCaseSearchBehaviour>.value(expected: Any): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected value shall be searched (ignoring case), using a non disjoint search.

infix fun <T : CharSequence> CharSequenceContains.Builder<T, IgnoringCaseSearchBehaviour>.value(expected: Any): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected value shall be searched (ignoring case), using a non disjoint search where it needs to be contained at least once.

infix fun <E, T : Iterable<E>> IterableContains.CheckerOption<E, T, InAnyOrderSearchBehaviour>.value(expected: E): AssertionPlant<T>

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

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InAnyOrderOnlySearchBehaviour>.value(expected: E): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable must contain only the expected value.

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlySearchBehaviour>.value(expected: E): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable needs to contain only the expected value.

infix fun <K, V : Any> Assert<Entry<K, V>>.value(assertionCreator: Assert<V>.() -> Unit): AssertionPlant<Entry<K, V>>

Makes the assertion that the Assert.subject's property value holds all assertions the given assertionCreator might create for it.

values

infix fun <K, V, T : Map<out K, V>> Assert<T>.values(assertionCreator: Assert<Collection<V>>.() -> Unit): AssertionPlant<T>

Makes the assertion that the Assert.subject's property values holds all assertions the given assertionCreator might create.

within

infix fun <E, T : Iterable<E>> IterableContains.Builder<E, T, InOrderOnlyGroupedSearchBehaviour>.within(group: group): IterableContains.Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>

Defines that the Iterable contains groups of entries in order only where the entries within the group can be in any order.