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

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

Contains API which provides a pure fluent API in English and which has its design focus on usability in conjunction with code completion.

Properties

and

val <T : Any> AssertionPlant<T>.and: AssertionPlant<T>

Can be used to separate assertions when using the fluent API.

contains

val <T : CharSequence> Assert<T>.contains: CharSequenceContainsBuilder<T, CharSequenceContainsNoOpSearchBehaviour>

Creates a CharSequenceContainsBuilder based on this AssertionPlant which allows to define more sophisticated contains assertions.

containsNot

val <T : CharSequence> Assert<T>.containsNot: CharSequenceContainsNotCheckerBuilder<T, CharSequenceContainsNotSearchBehaviour>

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

ignoringCase

val <T : CharSequence> CharSequenceContainsBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.ignoringCase: CharSequenceContainsBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>

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

val <T : CharSequence> CharSequenceContainsNotCheckerBuilder<T, CharSequenceContainsNotSearchBehaviour>.ignoringCase: CharSequenceContainsNotCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>

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

inAnyOrder

val <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsNoOpSearchBehaviour>.inAnyOrder: 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.

inOrder

val <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsNoOpSearchBehaviour>.inOrder: 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.

only

val <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.only: IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>
val <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderSearchBehaviour>.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.

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

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.

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

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.

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.

butAtMost

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.

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

fun <T : CharSequence> Assert<T>.contains(expected: Any, vararg otherExpected: Any): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains expected's toString representation and the toString representation of the otherExpected (if defined), using a non disjoint search.

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

Makes the assertion that AssertionPlant.subject contains expected and the otherExpected (if defined).

fun <E : Any, T : Iterable<E>> Assert<T>.contains(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: Assert<E>.() -> Unit): AssertionPlant<T>

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

containsDefaultTranslationOf

fun <T : CharSequence> Assert<T>.containsDefaultTranslationOf(expected: Translatable, vararg otherExpected: Translatable): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains expected's getDefault representation and the getDefault representations of the otherExpected (if defined), using a non disjoint search.

containsNot

fun <T : CharSequence> Assert<T>.containsNot(expected: Any, vararg otherExpected: Any): AssertionPlant<T>

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

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

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

containsNotDefaultTranslationOf

fun <T : CharSequence> Assert<T>.containsNotDefaultTranslationOf(expected: Translatable, vararg otherExpected: Translatable): AssertionPlant<T>

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

containsRegex

fun <T : CharSequence> Assert<T>.containsRegex(pattern: String, vararg otherPatterns: String): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains a sequence which matches the given regular expression pattern as well as the otherPatterns (if defined), using a non disjoint search.

containsStrictly

fun <E, T : Iterable<E>> Assert<T>.containsStrictly(expected: E, vararg otherExpected: E): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains only expected and the otherExpected (if defined) in the defined order.

fun <E : Any, T : Iterable<E>> Assert<T>.containsStrictly(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: Assert<E>.() -> Unit): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject contains only an entry holding the assertions created by the assertionCreator and an additional entry for each otherAssertionCreators (if defined) in the defined order holding the assertions created by them.

defaultTranslationOf

fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.defaultTranslationOf(expected: Translatable, vararg otherExpected: Translatable): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected's getDefault representation as well as the getDefault representations of the otherExpected (if defined) shall be searched, using a non disjoint search.

fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.defaultTranslationOf(expected: Translatable, vararg otherExpected: Translatable): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the expected's getDefault representation as well as the getDefault representations of the otherExpected (if defined) shall be searched (ignoring case), using a non disjoint search.

endsNotWith

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

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

endsWith

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

Makes the assertion that AssertionPlant.subject ends with expected.

entries

fun <E : Any, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.entries(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: 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 and search for entries which hold (one by one) the assertions created by the otherAssertionCreators.

fun <E : Any, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.entries(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: 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 assertionCreator might create -- equally an entry for each further otherAssertionCreators needs to be contained in the Iterable where it does not matter in which order the entries appear.

fun <E : Any, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.entries(assertionCreator: Assert<E>.() -> Unit, vararg otherAssertionCreators: 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 assertionCreator might create -- equally an entry for each further otherAssertionCreators, following the specified order, needs to be contained in the Iterable

entry

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.

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

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.

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

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

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

isA

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.

isEmpty

fun <T : CharSequence> Assert<T>.isEmpty(): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject.kotlin.text.isEmpty.

isEqualIncludingScale

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

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

isFalse

fun Assert<Boolean>.isFalse(): AssertionPlant<Boolean>

Makes the assertion that AssertionPlant.subject is false.

isGreaterOrEquals

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

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

isGreaterThan

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

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

isLessOrEquals

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

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

isLessThan

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

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

isNotEmpty

fun <T : CharSequence> Assert<T>.isNotEmpty(): AssertionPlant<T>

Makes the assertion that AssertionPlant.subject.kotlin.text.isNotEmpty.

isNotEqualIncludingScale

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

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

isNotNull

fun <T : Any> AssertionPlantNullable<T?>.isNotNull(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.

isNotNumericallyEqualTo

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

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

isNotSame

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

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

isNull

fun <T> AssertionPlantNullable<T>.isNull(): Unit

Makes the assertion that AssertionPlant.subject is null.

isNumericallyEqualTo

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

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

isSame

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

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

isTrue

fun Assert<Boolean>.isTrue(): AssertionPlant<Boolean>

Makes the assertion that AssertionPlant.subject is true.

message

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 message isNotNull and uses assertionCreator which might create further Assertions which are lazily evaluated at the end.

notOrAtMost

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.

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.

notToBe

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

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

object

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.

fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.object(expected: E): AssertionPlant<T>
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.

objects

fun <E, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.objects(expected: E, vararg otherExpected: E): AssertionPlant<T>

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

fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.objects(expected: E, vararg otherExpected: E): AssertionPlant<T>

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

fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.objects(expected: E, vararg otherExpected: E): AssertionPlant<T>

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

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

fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.regex(pattern: String, vararg otherPatterns: String): AssertionPlant<T>

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

fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.regex(pattern: String, vararg otherPatterns: String): AssertionPlant<T>

Finishes the specification of the sophisticated contains assertion where the given regular expression pattern as well as the otherPatterns are 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

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

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

startsWith

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

Makes the assertion that AssertionPlant.subject starts with expected.

toBe

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

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

toBeWithErrorTolerance

fun Assert<Float>.toBeWithErrorTolerance(expected: Float, tolerance: Float): AssertionPlant<Float>
fun Assert<Double>.toBeWithErrorTolerance(expected: Double, tolerance: Double): AssertionPlant<Double>
fun Assert<BigDecimal>.toBeWithErrorTolerance(expected: BigDecimal, tolerance: BigDecimal): AssertionPlant<BigDecimal>

Makes the assertion that AssertionPlant.subject is equal to expected with an error tolerance (range including bounds).

toThrow

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

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

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

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.

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.

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.

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

values

fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsNoOpSearchBehaviour>.values(expected: Any, vararg otherExpected: Any): AssertionPlant<T>

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

fun <T : CharSequence> CharSequenceContainsCheckerBuilder<T, CharSequenceContainsIgnoringCaseSearchBehaviour>.values(expected: Any, vararg otherExpected: Any): AssertionPlant<T>

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

fun <E, T : Iterable<E>> IterableContainsCheckerBuilder<E, T, IterableContainsInAnyOrderSearchBehaviour>.values(expected: E, vararg otherExpected: E): AssertionPlant<T>

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

fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInAnyOrderOnlySearchBehaviour>.values(expected: E, vararg otherExpected: E): AssertionPlant<T>

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

fun <E, T : Iterable<E>> IterableContainsBuilder<E, T, IterableContainsInOrderOnlySearchBehaviour>.values(expected: E, vararg otherExpected: E): AssertionPlant<T>

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