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

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

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

Types

DefaultTranslationsOf

class DefaultTranslationsOf

Empty

object Empty

Represents a helper construct which allows to express emptiness. It can be used for a parameter less function so that it has one parameter and thus can be used as infix function.

Entries

class Entries<in T : Any, out A : (Assert<T>) -> Unit>

Objects

class Objects<out T>

RegexPatterns

class RegexPatterns

Values

class Values<out T>

case

object case

Represents the pseudo keyword case as in ignoring case.

contain

object contain

Represents the pseudo keyword contain as in to contain.

only

object only

Represents the pseudo keyword only as in but only.

order

object order

Represents the pseudo keyword order as in inAny order.

Functions

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.

atLeast

infix fun <T : CharSequence, S : SearchBehaviour> CharSequenceContainsBuilder<T, S>.atLeast(times: Int): CharSequenceContainsAtLeastCheckerBuilder<T, S>

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

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.atLeast(times: Int): IterableContainsAtLeastCheckerBuilder<E, T>

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> CharSequenceContainsBuilder<T, S>.atMost(times: Int): CharSequenceContainsAtMostCheckerBuilder<T, S>

Restricts a contains assertion by specifying that the number of occurrences of the object 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>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.atMost(times: Int): IterableContainsAtMostCheckerBuilder<E, T>

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>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.but(only: only): IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>
infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderSearchBehaviour>.but(only: only): IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>

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> CharSequenceContainsAtLeastCheckerBuilder<T, S>.butAtMost(times: Int): CharSequenceContainsButAtMostCheckerBuilder<T, S>

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

infix fun <E, T : Iterable<E>> IterableContainsAtLeastCheckerBuilder<E, T>.butAtMost(times: Int): IterableContainsButAtMostCheckerBuilder<E, T>

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(defaultTranslationOf: DefaultTranslationsOf): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains DefaultTranslationsOf.expected's getDefault representation and the getDefault representations of the DefaultTranslationsOf.otherExpected (if defined), 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, T : Iterable<E>> Assert<T>.contains(expected: E): AssertionPlant<T>

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

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

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

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

Makes the assertion that AssertionPlant.subject contains the expected objects.

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(entries: Entries<E, Assert<E>.() -> Unit>): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains an entry holding the assertions created by the Entries.assertionCreator and an additional entry for each Entries.otherAssertionCreators (if defined) where it does not matter in which order the entries appear.

containsDefaultTranslationOf

infix fun <T : CharSequence> Assert<T>.containsDefaultTranslationOf(translatable: Translatable): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains the getDefault representation of the given translatable.

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 <T : CharSequence> Assert<T>.containsNot(defaultTranslationsOf: DefaultTranslationsOf): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject does not contain DefaultTranslationsOf.expected's getDefault representation and neither one of the DefaultTranslationsOf.otherExpected's getDefault representation (if defined).

infix fun <E, 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, T : Iterable<E>> Assert<T>.containsNot(values: Values<E>): AssertionPlant<T>

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

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

Makes the assertion that AssertionPlant.subject does not contain the expected objects.

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, 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(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(objects: Objects<E>): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains only the expected objects 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(entries: Entries<E, Assert<E>.() -> Unit>): 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 defined) in the defined order holding the assertions created by them.

defaultTranslationOf

infix fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.defaultTranslationOf(translatable: Translatable): AssertionPlant<T>

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

infix fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.defaultTranslationOf(translatable: Translatable): AssertionPlant<T>

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

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>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.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>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.entry(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>
infix fun <E : Any, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.entry(assertionCreator: Assert<E>.() -> Unit): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the Iterable needs to contain only one entry which holds all assertions created by the given assertionCreator.

exactly

infix fun <T : CharSequence, S : SearchBehaviour> CharSequenceContainsBuilder<T, S>.exactly(times: Int): CharSequenceContainsExactlyCheckerBuilder<T, S>

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

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.exactly(times: Int): IterableContainsExactlyCheckerBuilder<E, T>

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.

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> CharSequenceContainsBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.ignoring(case: case): CharSequenceContainsBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>

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

infix fun <T : CharSequence> CharSequenceContainsNotCheckerBuilder<T, CharSequenceContainsNotSearchBehaviour>.ignoring(case: case): CharSequenceContainsNotCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>

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

inAny

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsNoOpSearchBehaviour>.inAny(order: order): IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>

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>> IterableContainsBuilder<E, T, IterableContainsNoOpSearchBehaviour>.inGiven(order: order): IterableContainsBuilder<E, T, IterableContainsInOrderSearchBehaviour>

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.

isNotSame

infix fun <T : Any> Assert<T>.isNotSame(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.

isSame

infix fun <T : Any> Assert<T>.isSame(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: AssertionPlant<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.

notOrAtMost

infix fun <T : CharSequence, S : SearchBehaviour> CharSequenceContainsBuilder<T, S>.notOrAtMost(times: Int): CharSequenceContainsNotOrAtMostCheckerBuilder<T, S>

Restricts a contains assertion by specifying that the number of occurrences of the object 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>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.notOrAtMost(times: Int): IterableContainsNotOrAtMostCheckerBuilder<E, T>

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): CharSequenceContainsNotCheckerBuilder<T, CharSequenceContainsNotSearchBehaviour>

Creates a CharSequenceContainsBuilder 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.

object

infix fun <E, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.object(expected: E): AssertionPlant<T>

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

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.object(expected: E): AssertionPlant<T>
infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.object(expected: E): AssertionPlant<T>

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

property

fun <T : Any, TProperty : Any> Assert<T>.property(property: KProperty0<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> Assert<T>.property(property: KProperty0<TProperty>, assertionCreator: AssertionPlant<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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction0<TReturnValue>): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction0<TReturnValue>, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction1<T1, TReturnValue>, arg1: T1): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction1<T1, TReturnValue>, arg1: T1, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction2<T1, T2, TReturnValue>, arg1: T1, arg2: T2): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction2<T1, T2, TReturnValue>, arg1: T1, arg2: T2, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction3<T1, T2, T3, TReturnValue>, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction3<T1, T2, T3, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<TReturnValue>

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, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.the(translatables: DefaultTranslationsOf): AssertionPlant<T>

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

infix fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.the(translatables: DefaultTranslationsOf): AssertionPlant<T>

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

infix fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.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, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.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>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.the(objects: Objects<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected objects shall be searched within the iterable.

infix fun <E : Any, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.the(entries: Entries<E, Assert<E>.() -> Unit>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where an entry shall be searched which holds all assertions Entries.assertionCreator might create and search for entries which hold (one by one) the assertions created by the Entries.otherAssertionCreators.

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.the(values: Values<E>): AssertionPlant<T>

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

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.the(objects: Objects<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected objects need to be contained in Iterable where it does not matter in which order.

infix fun <E : Any, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.the(entries: Entries<E, Assert<E>.() -> Unit>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the entry needs to be contained in the Iterable which holds all assertions Entries.assertionCreator might create -- equally an entry for each further Entries.otherAssertionCreators needs to be contained in the Iterable where it does not matter in which order the entries appear.

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.the(values: Values<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected values need to be contained in Iterable in the specified order.

infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.the(objects: Objects<E>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected objects need to be contained in Iterable in the specified order.

infix fun <E : Any, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.the(entries: Entries<E, Assert<E>.() -> Unit>): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the entry needs to be contained in the Iterable which holds all assertions Entries.assertionCreator might create -- equally an entry for each further Entries.otherAssertionCreators, following the specified order, needs to be contained in the Iterable

to

infix fun <T : CharSequence> Assert<T>.to(contain: contain): CharSequenceContainsBuilder<T, CharSequenceContainsNoOpSearchBehaviour>

Creates a CharSequenceContainsBuilder 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(onlyNullAllowed: 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

fun <TExpected : Throwable> ThrowableThrownBuilder.toThrow(): Unit

Makes the assertion that the thrown Throwable is of type TExpected.

infix fun <TExpected : Throwable> ThrowableThrownBuilder.toThrow(assertionCreator: AssertionPlant<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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.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> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.value(expected: Any): AssertionPlant<T>

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

infix fun <E, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.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>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.value(expected: E): AssertionPlant<T>
infix fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.value(expected: E): AssertionPlant<T>

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