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

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

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

Contains API which provides an infix API in English and which has its design focus on usability in conjunction with code completion.

Types

Entries	`class Entries<in T : Any> : GroupWithoutNullableEntries<Assert<T>.() -> Unit>` Parameter object to express a GroupWithoutNullableEntries of identification lambdas.
Entry	`class Entry<in T : Any> : GroupWithoutNullableEntries<Assert<T>.() -> Unit>` Parameter object to express a Group with a single identification lambda.
NullableEntries	`class NullableEntries<in T : Any> : GroupWithNullableEntries<Assert<T>.() -> Unit>` Parameter object to express a GroupWithNullableEntries of nullable identification lambdas.
NullableEntry	`class NullableEntry<in T : Any> : GroupWithNullableEntries<Assert<T>.() -> Unit>` Parameter object to express a Group with a single nullable identification lambda.
NullableValue	`class NullableValue<out T> : GroupWithNullableEntries<T>` Represents a Group with a single nullable value.
NullableValues	`class NullableValues<out T> : GroupWithNullableEntries<T>` Parameter object to express `(T, vararg T) where T: Any?` in the infix-api.
Order	`class Order<T, G : Group<T>>` Parameter object to express `Group<T>, Group<T>, vararg Group<T>` in the infix-api.
RegexPatterns	`class RegexPatterns` Parameter object to express `String, vararg String` in the infix-api.
Value	`class Value<out T : Any> : GroupWithoutNullableEntries<T>` Parameter object to express a Group with a single element.
Values	`class Values<out T : Any> : GroupWithoutNullableEntries<T>` Parameter object to express `(T, vararg T) where T: Any` in the infix-api.

Functions

all	`infix fun <E : Any, T : Iterable<E>> Assert<T>.all(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject has at least one element and that every element holds all assertions created by the assertionCreator. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.all(nullableEntry: NullableEntry<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) has at least one element and that every element holds all assertions created by the nullableEntry.assertionCreator or that all elements are `null` in case nullableEntry is defined as `null`.
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>> Builder<E, T, InOrderSearchBehaviour>.and(only: only): <ERROR CLASS>` 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(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains an entry holding the assertions created by the assertionCreator. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.any(nullableEntry: NullableEntry<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains an entry holding the assertions created by the nullableEntry.assertionCreator or an entry which is `null` in case nullableEntry is defined as `null`.
asIterable	`fun <E> Assert<Array<E>>.asIterable(): AssertionPlant<Iterable<E>>` Turns `Assert<Array<E>>` into `Assert<Iterable<E>>`. `fun Assert<ByteArray>.asIterable(): AssertionPlant<Iterable<Byte>>` Turns `Assert<CharArray>` into `Assert<Iterable<Byte>>`. `fun Assert<CharArray>.asIterable(): AssertionPlant<Iterable<Char>>` Turns `Assert<CharArray>` into `Assert<Iterable<Char>>`. `fun Assert<ShortArray>.asIterable(): AssertionPlant<Iterable<Short>>` Turns `Assert<ShortArray>` into `Assert<Iterable<Short>>`. `fun Assert<IntArray>.asIterable(): AssertionPlant<Iterable<Int>>` Turns `Assert<IntArray>` into `Assert<Iterable<Int>>`. `fun Assert<LongArray>.asIterable(): AssertionPlant<Iterable<Long>>` Turns `Assert<LongArray>` into `Assert<Iterable<Double>>`. `fun Assert<FloatArray>.asIterable(): AssertionPlant<Iterable<Float>>` Turns `Assert<FloatArray>` into `Assert<Iterable<Float>>`. `fun Assert<DoubleArray>.asIterable(): AssertionPlant<Iterable<Double>>` Turns `Assert<DoubleArray>` into `Assert<Iterable<Double>>`. `fun Assert<BooleanArray>.asIterable(): AssertionPlant<Iterable<Boolean>>` Turns `Assert<BooleanArray>` into `Assert<Iterable<Boolean>>`. `fun <E, T> Assert<T>.asIterable(): <ERROR CLASS>` Turns `Assert<Sequence<E>>` into `Assert<Iterable<E>>`.
atLeast	`infix fun <T : CharSequence, S : SearchBehaviour> 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> 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 : SearchBehaviour> 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> 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>> Builder<E, T, InAnyOrderSearchBehaviour>.but(only: only): <ERROR CLASS>` 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 : 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 AssertionPlant.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 AssertionPlant.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 AssertionPlant.subject contains a sequence which matches the given patterns using a non disjoint search. `infix fun <E : Any, T : Iterable<E>> Assert<T>.contains(expected: E): <ERROR CLASS>` Makes the assertion that AssertionPlant.subject contains the expected value. `infix fun <E, T : Iterable<E>> Assert<T>.contains(expected: NullableValue<E>): <ERROR CLASS>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains the expected nullable value. `infix fun <E : Any, T : Iterable<E>> Assert<T>.contains(values: Values<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains the expected values. `infix fun <E, T : Iterable<E>> Assert<T>.contains(nullableValues: NullableValues<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains the expected nullableValues. `infix fun <E : Any, T : Iterable<E>> Assert<T>.contains(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains an entry holding the assertions created by the assertionCreator where it does not matter in which order the entries appear. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.contains(nullableEntry: NullableEntry<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains an entry holding the assertions created by nullableEntry.assertionCreator or an entry which is `null` in case nullableEntry is defined as `null`. `infix fun <E : Any, T : Iterable<E>> Assert<T>.contains(entries: Entries<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains an entry holding the assertions created by the entries.assertionCreator -- likewise an entry (can be the same) is searched for each of the entries.otherAssertionCreators. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.contains(nullableEntries: NullableEntries<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains an entry holding the assertions created by nullableEntries.assertionCreator or an entry which is `null` in case nullableEntries.assertionCreator is defined as `null` -- likewise an entry (can be the same) is searched for each of the nullableEntries.otherAssertionCreators.
containsNot	`infix fun <T : CharSequence> Assert<T>.containsNot(expected: Any): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not expected's toString representation. `infix fun <T : CharSequence> Assert<T>.containsNot(values: Values<Any>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not contain the toString representation of the given values. `infix fun <E : Any, T : Iterable<E>> Assert<T>.containsNot(expected: E): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not contain the expected value. `infix fun <E : Any, T : Iterable<E>> Assert<T>.containsNot(values: Values<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not contain the expected values.
containsRegex	`infix fun <T : CharSequence> Assert<T>.containsRegex(pattern: String): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains a sequence which matches the given pattern.
containsStrictly	`infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(expected: E): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains only the expected value. `infix fun <E, T : Iterable<E>> Assert<T>.containsStrictly(expected: NullableValue<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains only the expected nullable value. `infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(values: Values<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains only the expected values in the defined order. `infix fun <E, T : Iterable<E>> Assert<T>.containsStrictly(nullableValues: NullableValues<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains only the expected nullableValues in the defined order. `infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains only one entry which is holding the assertions created by the assertionCreator. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.containsStrictly(nullableEntry: NullableEntry<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains only one entry which is holding the assertions created by nullableEntry.assertionCreator or only one entry which is `null` in case nullableEntry is defined as `null`. `infix fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(entries: Entries<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject contains only an entry holding the assertions created by the entries.assertionCreator and an additional entry for each entries.otherAssertionCreators (if given) in the defined order holding the assertions created by them. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.containsStrictly(nullableEntries: NullableEntries<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) contains only an entry holding the assertions created by nullableEntries.assertionCreator or `null` in case nullableEntries.assertionCreator is defined as `null` and likewise an additional entry for each nullableEntries.otherAssertionCreators (if given) whereas the entries have to appear in the defined order.
endsNotWith	`infix fun <T : CharSequence> Assert<T>.endsNotWith(expected: CharSequence): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not end with expected.
endsWith	`infix fun <T : CharSequence> Assert<T>.endsWith(expected: CharSequence): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject ends with expected.
entry	`infix fun <E : Any, T : Iterable<E>> CheckerOption<E, T, InAnyOrderSearchBehaviour>.entry(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where an entry shall be searched which holds all assertions assertionCreator might create. `infix fun <E : Any, T : Iterable<E>> Builder<E, T, InAnyOrderOnlySearchBehaviour>.entry(assertionCreator: 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 assertionCreator. `infix fun <E : Any, T : Iterable<E>> Builder<E, T, InOrderOnlySearchBehaviour>.entry(assertionCreator: 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 assertionCreator.
exactly	`infix fun <T : CharSequence, S : SearchBehaviour> 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> 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.
grouped	`infix fun <E, T : Iterable<E>> Builder<E, T, InOrderOnlySearchBehaviour>.grouped(entries: entries): <ERROR CLASS>` 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 AssertionPlant.subject's Collection.size is size.
ignoring	`infix fun <T : CharSequence> Builder<T, NoOpSearchBehaviour>.ignoring(case: case): 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 : Any, T : Iterable<E>> Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAny(order: Order<E, GroupWithoutNullableEntries<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, T : Iterable<E>> Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAny(order: Order<E, GroupWithNullableEntries<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 nullable 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>> Builder<E, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAny(order: Order<Assert<E>.() -> Unit, GroupWithoutNullableEntries<Assert<E>.() -> Unit>>): AssertionPlant<T>` `infix fun <E : Any, T : Iterable<E?>> Builder<E?, T, InOrderOnlyGroupedWithinSearchBehaviour>.inAny(order: Order<Assert<E>.() -> Unit, GroupWithNullableEntries<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>> Builder<E, T, NoOpSearchBehaviour>.inAny(order: order): <ERROR CLASS>` Defines that the search behaviour "find entries `in any order` in the Iterable" shall be applied to this sophisticated `contains` in Iterable assertion.
inGiven	`infix fun <E, T : Iterable<E>> Builder<E, T, NoOpSearchBehaviour>.inGiven(order: order): <ERROR CLASS>` 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 AssertionPlant.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 AssertionPlant.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 AssertionPlant.subject is greater than or equals expected.
isGreaterThan	`infix fun <T : Comparable<T>> Assert<T>.isGreaterThan(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject is greater than expected.
isLessOrEquals	`infix fun <T : Comparable<T>> Assert<T>.isLessOrEquals(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject is less than or equals expected.
isLessThan	`infix fun <T : Comparable<T>> Assert<T>.isLessThan(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject is less than expected.
isNotEqualIncludingScale	`infix fun <T : BigDecimal> Assert<T>.isNotEqualIncludingScale(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.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 AssertionPlant.subject is not numerically equal to expected.
isNotSameAs	`infix fun <T : Any> Assert<T>.isNotSameAs(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject is not the same instance as expected.
isNumericallyEqualTo	`infix fun <T : BigDecimal> Assert<T>.isNumericallyEqualTo(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject is numerically equal to expected.
isSameAs	`infix fun <T : Any> Assert<T>.isSameAs(expected: T): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject is the same instance as expected.
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(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not contain a single entry which holds all assertions created by the assertionCreator. `infix fun <E : Any, T : Iterable<E?>> Assert<T>.none(nullableEntry: NullableEntry<E>): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject (which has a nullable entry type) does not contain a single entry which holds all assertions created by nullableEntry.assertionCreator or does not contain a single entry which is `null` in case nullableEntry is defined as `null`.
notOrAtMost	`infix fun <T : CharSequence, S : SearchBehaviour> 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> 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 AssertionPlant.subject is not (equal to) expected. `infix fun <T : CharSequence> Assert<T>.notToBe(onlyEmptyAllowed: Empty): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject.kotlin.text.isNotEmpty.
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 : Any> AssertionPlantNullable<T?>.notToBeNullBut(expected: T): Unit` Makes the assertion that AssertionPlantNullable.subject is not null but the expected value.
nullableEntry	`infix fun <E : Any, T : Iterable<E?>> CheckerOption<E?, T, InAnyOrderSearchBehaviour>.nullableEntry(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?>> Builder<E?, T, InAnyOrderOnlySearchBehaviour>.nullableEntry(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?>> Builder<E?, T, InOrderOnlySearchBehaviour>.nullableEntry(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`.
nullableValue	`infix fun <E, T : Iterable<E>> CheckerOption<E, T, InAnyOrderSearchBehaviour>.nullableValue(expectedOrNull: E): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the expected nullable value shall be searched within the Iterable. `infix fun <E, T : Iterable<E>> Builder<E, T, InAnyOrderOnlySearchBehaviour>.nullableValue(expectedOrNull: E): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the Iterable must contain only the expected nullable value. `infix fun <E, T : Iterable<E>> Builder<E, T, InOrderOnlySearchBehaviour>.nullableValue(expectedOrNull: E): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the Iterable needs to contain only the expected nullable value.
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> 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> 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.
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.
startsNotWith	`infix fun <T : CharSequence> Assert<T>.startsNotWith(expected: CharSequence): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject does not start with expected.
startsWith	`infix fun <T : CharSequence> Assert<T>.startsWith(expected: CharSequence): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject starts with expected.
the	`infix fun <T : CharSequence> 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> 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> 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> 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 <E : Any, T : Iterable<E>> 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, T : Iterable<E>> CheckerOption<E, T, InAnyOrderSearchBehaviour>.the(nullableValues: NullableValues<E>): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the expected nullableValues shall be searched within the Iterable. `infix fun <E : Any, T : Iterable<E>> 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 holds all assertions entries.assertionCreator might create -- likewise an entry (can be the same) is searched for each of the entries.otherAssertionCreators. `infix fun <E : Any, T : Iterable<E?>> CheckerOption<E?, T, InAnyOrderSearchBehaviour>.the(nullableEntries: NullableEntries<E>): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where an entry shall be searched which either holds all assertions nullableEntries.assertionCreator might create or needs to be `null` in case nullableEntries.assertionCreator is defined as `null` -- likewise an entry (can be the same) is searched for each of the nullableEntries.otherAssertionCreators. `infix fun <E : Any, T : Iterable<E>> 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 the Iterable but it does not matter in which order. `infix fun <E, T : Iterable<E>> Builder<E, T, InAnyOrderOnlySearchBehaviour>.the(values: NullableValues<E>): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the expected nullable values must be contained in Iterable but it does not matter in which order. `infix fun <E : Any, T : Iterable<E>> 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.assertionCreator might create -- likewise an entry for each entries.otherAssertionCreators 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 : Any, T : Iterable<E?>> Builder<E?, T, InAnyOrderOnlySearchBehaviour>.the(nullableEntries: NullableEntries<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 nullableEntries.assertionCreator might create or it needs to be `null` in case nullableEntries.assertionCreator is defined as `null` -- likewise an entry for each nullableEntries.otherAssertionCreators 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 : Any, T : Iterable<E>> 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, T : Iterable<E>> Builder<E, T, InOrderOnlySearchBehaviour>.the(nullableValues: NullableValues<E>): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the Iterable needs to contain only the expected nullableValues in the specified order. `infix fun <E : Any, T : Iterable<E>> 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.assertionCreator might create and likewise a further entry for each entries.otherAssertionCreators (if given) whereas the entries have to appear in the specified order. `infix fun <E : Any, T : Iterable<E?>> Builder<E?, T, InOrderOnlySearchBehaviour>.the(nullableEntries: NullableEntries<E>): AssertionPlant<T>` Finishes the specification of the sophisticated `contains` assertion where the Iterable needs to contain only an entry which holds all assertions nullableEntries.assertionCreator might create or is `null` in case nullableEntries.assertionCreator is defined as `null` and likewise a further entry for each nullableEntries.otherAssertionCreators (if given) whereas the entries have to appear in the specified order.
to	`infix fun <T : CharSequence> Assert<T>.to(contain: contain): 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 AssertionPlant.subject is (equal to) expected. `infix fun <T> AssertionPlantNullable<T>.toBe(null: Nothing?): Unit` Makes the assertion that AssertionPlant.subject is `null`. `infix fun <T : CharSequence> Assert<T>.toBe(Empty: Empty): AssertionPlant<T>` Makes the assertion that AssertionPlant.subject.kotlin.text.isEmpty.
toThrow	`infix fun <TExpected : Throwable> Builder.toThrow(assertionCreator: Assert<TExpected>.() -> Unit): Unit` Makes the assertion that the thrown Throwable is of type TExpected and it assertionCreator which are checked additionally as well.
value	`infix fun <T : CharSequence> 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> 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 <E : Any, T : Iterable<E>> 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 : Any, T : Iterable<E>> 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 : Any, T : Iterable<E>> 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.
within	`infix fun <E, T : Iterable<E>> Builder<E, T, InOrderOnlyGroupedSearchBehaviour>.within(group: group): <ERROR CLASS>` Defines that the Iterable contains groups of entries `in order only` where the entries within the group can be in any order.