atrium-api-cc-en_GB-jvm / ch.tutteli.atrium.api.cc.en_GB

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

Types

Entries

class Entries<in T : Any>

Parameter object to express a Group of identification lambdas.

Entry

class Entry<in T : Any>

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

KeyNullableValue

data class KeyNullableValue<out K, V : Any>

KeyValue

data class KeyValue<out K, V : Any>

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

NullableEntries

class NullableEntries<T : Any>

NullableEntry

class NullableEntry<T : Any>

NullableValue

data class NullableValue<T>

NullableValues

class NullableValues<T>

Value

data class Value<out T>

Represents a Group with a single value.

Values

class Values<out T>

Represents a Group of multiple values.

Properties

and

val <T : Any> <ERROR CLASS><T>.and: <ERROR CLASS><T>

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

contains

val <T : CharSequence> <ERROR CLASS><T>.contains: <ERROR CLASS><T, <ERROR CLASS>>

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

containsNot

val <T : CharSequence> <ERROR CLASS><T>.containsNot: NotCheckerOption<T, <ERROR CLASS>>

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

first

val <K : Any> <ERROR CLASS><Pair<K, *>>.first: <ERROR CLASS><K>

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

grouped

val <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.grouped: <ERROR CLASS>

Defines that the Iterable contains in order only groups of entries whereas the order within the group is specified as next step.

ignoringCase

val <T : CharSequence> <ERROR CLASS><T, <ERROR CLASS>>.ignoringCase: <ERROR CLASS><T, <ERROR CLASS>>

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

val <T : CharSequence> NotCheckerOption<T, <ERROR CLASS>>.ignoringCase: NotCheckerOption<T, <ERROR CLASS>>

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

inAnyOrder

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

inOrder

val <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.inOrder: <ERROR CLASS>

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

key

val <K : Any> <ERROR CLASS><Entry<K, *>>.key: <ERROR CLASS><K>

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

keys

val <K> <ERROR CLASS><Map<K, *>>.keys: <ERROR CLASS><Set<K>>

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

only

val <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.only: <ERROR CLASS>

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

second

val <V : Any> <ERROR CLASS><Pair<*, V>>.second: <ERROR CLASS><V>

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

size

val <ERROR CLASS><Collection<*>>.size: <ERROR CLASS><Int>

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

value

val <V : Any> <ERROR CLASS><Entry<*, V>>.value: <ERROR CLASS><V>

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

values

val <V> <ERROR CLASS><Map<*, V>>.values: <ERROR CLASS><Collection<V>>

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

within

val <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.within: <ERROR CLASS>

A filler word to emphasis that the next step defines the order within expected groups of values.

Functions

all

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.all(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS>

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

allOfNullable

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.allOfNullable(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS>

and

infix fun <T : Any> <ERROR CLASS><T>.and(assertionCreator: <ERROR CLASS><T>.() -> Unit): <ERROR CLASS>

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

any

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.any(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

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

anyOfNullable

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.anyOfNullable(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

asEntries

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

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

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

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

asIterable

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

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

fun <E> <ERROR CLASS><Array<out E>>.asIterable(assertionCreator: <ERROR CLASS><Iterable<E>>.() -> Unit): <ERROR CLASS><Iterable<E>>

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

fun <ERROR CLASS><ByteArray>.asIterable(): <ERROR CLASS><Iterable<Byte>>

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

fun <ERROR CLASS><ByteArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Byte>>.() -> Unit): <ERROR CLASS><Iterable<Byte>>

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

fun <ERROR CLASS><CharArray>.asIterable(): <ERROR CLASS><Iterable<Char>>

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

fun <ERROR CLASS><CharArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Char>>.() -> Unit): <ERROR CLASS><Iterable<Char>>

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

fun <ERROR CLASS><ShortArray>.asIterable(): <ERROR CLASS><Iterable<Short>>

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

fun <ERROR CLASS><ShortArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Short>>.() -> Unit): <ERROR CLASS><Iterable<Short>>

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

fun <ERROR CLASS><IntArray>.asIterable(): <ERROR CLASS><Iterable<Int>>

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

fun <ERROR CLASS><IntArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Int>>.() -> Unit): <ERROR CLASS><Iterable<Int>>

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

fun <ERROR CLASS><LongArray>.asIterable(): <ERROR CLASS><Iterable<Long>>

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

fun <ERROR CLASS><LongArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Long>>.() -> Unit): <ERROR CLASS><Iterable<Long>>

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

fun <ERROR CLASS><FloatArray>.asIterable(): <ERROR CLASS><Iterable<Float>>

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

fun <ERROR CLASS><FloatArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Float>>.() -> Unit): <ERROR CLASS><Iterable<Float>>

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

fun <ERROR CLASS><DoubleArray>.asIterable(): <ERROR CLASS><Iterable<Double>>

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

fun <ERROR CLASS><DoubleArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Double>>.() -> Unit): <ERROR CLASS><Iterable<Double>>

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

fun <ERROR CLASS><BooleanArray>.asIterable(): <ERROR CLASS><Iterable<Boolean>>

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

fun <ERROR CLASS><BooleanArray>.asIterable(assertionCreator: <ERROR CLASS><Iterable<Boolean>>.() -> Unit): <ERROR CLASS><Iterable<Boolean>>

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

fun <E> <ERROR CLASS><Sequence<E>>.asIterable(): <ERROR CLASS><Iterable<E>>

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

atLeast

fun <T : CharSequence, S> <ERROR CLASS><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.

fun <E, T : Iterable<E>, S> <ERROR CLASS><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

fun <T : CharSequence, S> <ERROR CLASS><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.

fun <E, T : Iterable<E>, S> <ERROR CLASS><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.

butAtMost

fun <T : CharSequence, S> 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.

fun <E, T : Iterable<E>, S> 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

fun <T : CharSequence> <ERROR CLASS><T>.contains(expected: Any, vararg otherExpected: Any): <ERROR CLASS><T>

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

fun <E, T : Iterable<E>> <ERROR CLASS><T>.contains(expected: E, vararg otherExpected: E): <ERROR CLASS><T>

c Makes the assertion that the Assert.subject contains the expected value and the otherExpected values (if given).

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.contains(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

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

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.contains(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?, vararg otherAssertionCreatorsOrNulls: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

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

fun <K, V, T : Map<out K, V>> <ERROR CLASS><T>.contains(keyValuePair: Pair<K, V>, vararg otherPairs: Pair<K, V>): <ERROR CLASS>

Makes the assertion that the Assert.subject contains a key as defined by keyValuePair's Pair.first with a corresponding value as defined by keyValuePair's Pair.second -- optionally the same assertions are created for the otherPairs.

fun <K, V : Any, T : Map<out K, V?>> <ERROR CLASS><T>.contains(keyValue: KeyValue<K, V>, vararg otherKeyValues: KeyValue<K, V>): <ERROR CLASS>

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

containsExactly

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsExactly(expected: E, vararg otherExpected: E): <ERROR CLASS><T>

Makes the assertion that the Assert.subject contains only the expected value and the otherExpected values (if given) in the defined order.

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.containsExactly(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

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

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.containsExactly(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?, vararg otherAssertionCreatorsOrNulls: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

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

containsKey

fun <K> <ERROR CLASS><Map<out K, *>>.containsKey(key: K): <ERROR CLASS>

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

containsNot

fun <T : CharSequence> <ERROR CLASS><T>.containsNot(expected: Any, vararg otherExpected: Any): <ERROR CLASS>

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

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsNot(expected: E, vararg otherExpected: E): <ERROR CLASS>

Makes the assertion that the Assert.subject does not contain the expected value and neither one of the otherExpected values (if given).

containsNotKey

fun <K> <ERROR CLASS><Map<out K, *>>.containsNotKey(key: K): <ERROR CLASS>

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

containsNullableEntries

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.containsNullableEntries(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?, vararg otherAssertionCreatorsOrNulls: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

containsNullableEntry

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.containsNullableEntry(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

containsNullableValue

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsNullableValue(expectedOrNull: E): <ERROR CLASS><T>

containsNullableValues

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsNullableValues(expectedOrNull: E, vararg otherExpectedOrNulls: E): <ERROR CLASS><T>

containsRegex

fun <T : CharSequence> <ERROR CLASS><T>.containsRegex(pattern: String, vararg otherPatterns: String): <ERROR CLASS><T>

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

containsStrictly

fun <E : Any, T : Iterable<E>> <ERROR CLASS><T>.containsStrictly(expected: E, vararg otherExpected: E): <ERROR CLASS><T>
fun <E : Any, T : Iterable<E>> <ERROR CLASS><T>.containsStrictly(assertionCreator: <ERROR CLASS><E>.() -> Unit, vararg otherAssertionCreators: <ERROR CLASS><E>.() -> Unit): <ERROR CLASS><T>

containsStrictlyNullableEntries

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.containsStrictlyNullableEntries(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?, vararg otherAssertionCreatorsOrNulls: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

containsStrictlyNullableEntry

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.containsStrictlyNullableEntry(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

containsStrictlyNullableValue

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsStrictlyNullableValue(expectedOrNull: E): <ERROR CLASS><T>

containsStrictlyNullableValues

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsStrictlyNullableValues(expectedOrNull: E, vararg otherExpectedOrNulls: E): <ERROR CLASS><T>

endsNotWith

fun <T : CharSequence> <ERROR CLASS><T>.endsNotWith(expected: CharSequence): <ERROR CLASS>

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

endsWith

fun <T : CharSequence> <ERROR CLASS><T>.endsWith(expected: CharSequence): <ERROR CLASS>

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

entries

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><E?, T, <ERROR CLASS>>.entries(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?, vararg otherAssertionCreatorsOrNulls: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><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 -- likewise an entry (can be the same) is searched for each of the otherAssertionCreatorsOrNulls.

entry

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><E?, T, <ERROR CLASS>>.entry(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><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.

exactly

fun <T : CharSequence, S> <ERROR CLASS><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.

fun <E, T : Iterable<E>, S> <ERROR CLASS><E, T, S>.exactly(times: Int): ExactlyCheckerOption<E, T, S>

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

first

fun <K : Any, V> <ERROR CLASS><Pair<K, V>>.first(assertionCreator: <ERROR CLASS><K>.() -> Unit): <ERROR CLASS>

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

get

fun <E : Any, T : List<E>> <ERROR CLASS><T>.get(index: Int): <ERROR CLASS><E>

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

fun <E : Any, T : List<E>> <ERROR CLASS><T>.get(index: Int, assertionCreator: <ERROR CLASS><E>.() -> Unit): <ERROR CLASS>

Makes the assertion that the given index is within the bounds of Assert.subject and that the corresponding element holds all assertions the given assertionCreator might create for it.

getExisting

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

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

fun <K, V : Any, T : Map<out K, V>> <ERROR CLASS><T>.getExisting(key: K, assertionCreator: <ERROR CLASS><V>.() -> Unit): <ERROR CLASS>

Makes the assertion that the Assert.subject contains the given key and that the corresponding value holds all assertions the given assertionCreator might create for it.

hasSize

fun <T : Collection<*>> <ERROR CLASS><T>.hasSize(size: Int): <ERROR CLASS>

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

inAnyOrder

fun <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.inAnyOrder(firstGroup: <ERROR CLASS><E>, secondGroup: <ERROR CLASS><E>, vararg otherExpectedGroups: <ERROR CLASS><E>): <ERROR CLASS><T>

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

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><E?, T, <ERROR CLASS>>.inAnyOrder(firstGroup: <ERROR CLASS><(<ERROR CLASS><E>.() -> Unit)?>, secondGroup: <ERROR CLASS><(<ERROR CLASS><E>.() -> Unit)?>, vararg otherExpectedGroups: <ERROR CLASS><(<ERROR CLASS><E>.() -> Unit)?>): <ERROR CLASS><T>

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

isA

fun <TSub : Any> <ERROR CLASS><Any>.isA(assertionCreator: <ERROR CLASS><TSub>.() -> Unit): Unit

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

isEmpty

fun <T : CharSequence> <ERROR CLASS><T>.isEmpty(): <ERROR CLASS>

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

isEqualIncludingScale

fun <T : BigDecimal> <ERROR CLASS><T>.isEqualIncludingScale(expected: T): <ERROR CLASS>

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

isGreaterOrEquals

fun <T : Comparable<T>> <ERROR CLASS><T>.isGreaterOrEquals(expected: T): <ERROR CLASS>

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

isGreaterThan

fun <T : Comparable<T>> <ERROR CLASS><T>.isGreaterThan(expected: T): <ERROR CLASS>

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

isKeyValue

fun <K : Any, V : Any> <ERROR CLASS><Entry<K, V>>.isKeyValue(key: K, value: V): <ERROR CLASS><Entry<K, V>>

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

isLessOrEquals

fun <T : Comparable<T>> <ERROR CLASS><T>.isLessOrEquals(expected: T): <ERROR CLASS>

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

isLessThan

fun <T : Comparable<T>> <ERROR CLASS><T>.isLessThan(expected: T): <ERROR CLASS>

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

isNotBlank

fun <T : CharSequence> <ERROR CLASS><T>.isNotBlank(): <ERROR CLASS>

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

isNotEmpty

fun <T : CharSequence> <ERROR CLASS><T>.isNotEmpty(): <ERROR CLASS>

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

isNotEqualIncludingScale

fun <T : BigDecimal> <ERROR CLASS><T>.isNotEqualIncludingScale(expected: T): <ERROR CLASS>

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

isNotNumericallyEqualTo

fun <T : BigDecimal> <ERROR CLASS><T>.isNotNumericallyEqualTo(expected: T): <ERROR CLASS>

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

isNotSameAs

fun <T : Any> <ERROR CLASS><T>.isNotSameAs(expected: T): <ERROR CLASS>

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

isNumericallyEqualTo

fun <T : BigDecimal> <ERROR CLASS><T>.isNumericallyEqualTo(expected: T): <ERROR CLASS>

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

isSameAs

fun <T : Any> <ERROR CLASS><T>.isSameAs(expected: T): <ERROR CLASS>

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

key

fun <K : Any, V> <ERROR CLASS><Entry<K, V>>.key(assertionCreator: <ERROR CLASS><K>.() -> Unit): <ERROR CLASS>

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

keys

fun <K, V, T : Map<K, V>> <ERROR CLASS><T>.keys(assertionCreator: <ERROR CLASS><Set<K>>.() -> Unit): <ERROR CLASS>

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

message

fun <T : Throwable> <ERROR CLASS><T>.message(assertionCreator: <ERROR CLASS><String>.() -> Unit): Unit

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

messageContains

fun <T : Throwable> <ERROR CLASS><T>.messageContains(expected: Any, vararg otherExpected: Any): Unit

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

none

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.none(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS>

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

noneOfNullable

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><T>.noneOfNullable(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS>

notOrAtMost

fun <T : CharSequence, S> <ERROR CLASS><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.

fun <E, T : Iterable<E>, S> <ERROR CLASS><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.

notToBe

fun <T : Any> <ERROR CLASS><T>.notToBe(expected: T): <ERROR CLASS>

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

notToBeNull

fun <T : Any> <ERROR CLASS><T?>.notToBeNull(assertionCreator: <ERROR CLASS><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

fun <T : BigDecimal> <ERROR CLASS><T?>.notToBeNullBut(expected: T): Nothing

notToThrow

fun <ERROR CLASS>.notToThrow(): Unit

Makes the assertion that no Throwable is thrown at all.

nullableEntries

fun <E : Any, T : Iterable<E?>> <ERROR CLASS><E?, T, <ERROR CLASS>>.nullableEntries(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?, vararg otherAssertionCreatorsOrNulls: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

nullableEntry

infix fun <E : Any, T : Iterable<E?>> <ERROR CLASS><E?, T, <ERROR CLASS>>.nullableEntry(assertionCreatorOrNull: (<ERROR CLASS><E>.() -> Unit)?): <ERROR CLASS><T>

nullableValue

infix fun <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.nullableValue(expectedOrNull: E): <ERROR CLASS><T>

nullableValues

fun <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.nullableValues(expectedOrNull: E, vararg otherExpectedOrNulls: E): <ERROR CLASS><T>

property

fun <T : Any, TProperty : Any> <ERROR CLASS><T>.property(property: KProperty0<TProperty>): <ERROR CLASS><TProperty>
fun <T : Any, TProperty : Any> <ERROR CLASS><T>.property(property: KProperty1<T, TProperty>): <ERROR CLASS><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> <ERROR CLASS><T>.property(property: KProperty0<TProperty>, assertionCreator: <ERROR CLASS><TProperty>.() -> Unit): <ERROR CLASS><TProperty>
fun <T : Any, TProperty : Any> <ERROR CLASS><T>.property(property: KProperty1<T, TProperty>, assertionCreator: <ERROR CLASS><TProperty>.() -> Unit): <ERROR CLASS><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> <ERROR CLASS><T, <ERROR CLASS>>.regex(pattern: String, vararg otherPatterns: String): <ERROR CLASS><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.

returnValueOf

fun <T : Any, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction0<R>): <ERROR CLASS><R>
fun <T : Any, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction1<T, R>): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction0<R>, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>
fun <T : Any, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction1<T, R>, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction1<T1, R>, arg1: T1): <ERROR CLASS><R>
fun <T : Any, T1, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction2<T, T1, R>, arg1: T1): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction1<T1, R>, arg1: T1, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>
fun <T : Any, T1, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction2<T, T1, R>, arg1: T1, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction2<T1, T2, R>, arg1: T1, arg2: T2): <ERROR CLASS><R>
fun <T : Any, T1, T2, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction3<T, T1, T2, R>, arg1: T1, arg2: T2): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction2<T1, T2, R>, arg1: T1, arg2: T2, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>
fun <T : Any, T1, T2, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction3<T, T1, T2, R>, arg1: T1, arg2: T2, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): <ERROR CLASS><R>
fun <T : Any, T1, T2, T3, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction4<T, T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction3<T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>
fun <T : Any, T1, T2, T3, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction4<T, T1, T2, T3, R>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): <ERROR CLASS><R>
fun <T : Any, T1, T2, T3, T4, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction5<T, T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>
fun <T : Any, T1, T2, T3, T4, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction5<T, T1, T2, T3, T4, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): <ERROR CLASS><R>
fun <T : Any, T1, T2, T3, T4, T5, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction6<T, T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): <ERROR CLASS><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> <ERROR CLASS><T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>
fun <T : Any, T1, T2, T3, T4, T5, R : Any> <ERROR CLASS><T>.returnValueOf(method: KFunction6<T, T1, T2, T3, T4, T5, R>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>

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

second

fun <K, V : Any> <ERROR CLASS><Pair<K, V>>.second(assertionCreator: <ERROR CLASS><V>.() -> Unit): <ERROR CLASS>

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

size

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

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

startsNotWith

fun <T : CharSequence> <ERROR CLASS><T>.startsNotWith(expected: CharSequence): <ERROR CLASS>

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

startsWith

fun <T : CharSequence> <ERROR CLASS><T>.startsWith(expected: CharSequence): <ERROR CLASS>

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

toBe

fun <T : Any> <ERROR CLASS><T>.toBe(expected: T): <ERROR CLASS>

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

fun <T> toBe(plant: <ERROR CLASS><T>, void: Void?): Unit

toBeNullIfNullGivenElse

fun <T : Any> <ERROR CLASS><T?>.toBeNullIfNullGivenElse(assertionCreatorOrNull: (<ERROR CLASS><T>.() -> Unit)?): Unit

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

toBeWithErrorTolerance

fun <ERROR CLASS><Float>.toBeWithErrorTolerance(expected: Float, tolerance: Float): <ERROR CLASS>
fun <ERROR CLASS><Double>.toBeWithErrorTolerance(expected: Double, tolerance: Double): <ERROR CLASS>
fun <ERROR CLASS><BigDecimal>.toBeWithErrorTolerance(expected: BigDecimal, tolerance: BigDecimal): <ERROR CLASS>

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

toThrow

fun <TExpected : Throwable> <ERROR CLASS>.toThrow(assertionCreator: <ERROR CLASS><TExpected>.() -> Unit): Unit

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

value

fun <T : CharSequence> <ERROR CLASS><T, <ERROR CLASS>>.value(expected: Any): <ERROR CLASS><T>

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

fun <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.value(expected: E): <ERROR CLASS><T>

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

fun <K, V : Any> <ERROR CLASS><Entry<K, V>>.value(assertionCreator: <ERROR CLASS><V>.() -> Unit): <ERROR CLASS>

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

values

fun <T : CharSequence> <ERROR CLASS><T, <ERROR CLASS>>.values(expected: Any, vararg otherExpected: Any): <ERROR CLASS><T>

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

fun <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.values(expected: E, vararg otherExpected: E): <ERROR CLASS><T>

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

fun <K, V, T : Map<K, V>> <ERROR CLASS><T>.values(assertionCreator: <ERROR CLASS><Collection<V>>.() -> Unit): <ERROR CLASS>

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