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

Package ch.tutteli.atrium.api.fluent.en_GB

Types

Entries

class Entries<T : Any>

Parameter object to express a Group of identification lambdas.

Entry

class Entry<T : Any>

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

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 Expect receiver, which means one can either pass a lambda or null.

Value

data class Value<out T>

Represents a Group with a single value.

Values

class Values<out T>

Represents a Group of multiple values.

Annotations

ExperimentalWithOptions

annotation class ExperimentalWithOptions

Properties

and

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

Can be used to separate single assertions.

contains

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

Creates a CharSequenceContains.Builder based on this Expect 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 Expect which allows to define more sophisticated contains not assertions.

first

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

Creates an Expect for the property Pair.first of the subject of the assertion, 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, T : Entry<K, *>> <ERROR CLASS><T>.key: <ERROR CLASS><K>

Creates an Expect for the property Map.Entry.key of the subject of the assertion, so that further fluent calls are assertions about it.

keys

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

Creates an Expect for the property Map.keys of the subject of the assertion, so that further fluent calls are assertions about it.

message

val <T : Throwable> <ERROR CLASS><T>.message: <ERROR CLASS><String>

Expects that the property Throwable.message of the subject of the assertion is not null, creates an Expect for it and returns 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, T : Pair<*, V>> <ERROR CLASS><T>.second: <ERROR CLASS><V>

Creates an Expect for the property Pair.second of the subject of the assertion, so that further fluent calls are assertions about it.

size

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

Creates an Expect for the property Collection.size of the subject of the assertion, so that further fluent calls are assertions about it.

value

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

Creates an Expect for the property Map.Entry.value of the subject of the assertion, so that further fluent calls are assertions about it.

values

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

Creates an Expect for the property Map.values of the subject of the assertion, 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>

Expects that the subject of the assertion (an Iterable) 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.

and

infix fun <T> <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>

Expects that the subject of the assertion (an Iterable) contains an entry holding the assertions created by assertionCreatorOrNull or an entry which is null in case assertionCreatorOrNull is defined as null.

asEntries

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

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

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

Turns Expect<Map<K, V>> into Expect<Set<Map.Entry<K, V>>> and expects that it holds all assertions the given assertionCreator creates for it.

asIterable

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

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

fun <E, T : Sequence<E>> <ERROR CLASS><T>.asIterable(assertionCreator: <ERROR CLASS><Iterable<E>>.() -> Unit): <ERROR CLASS><T>

Expects that the subject of the assertion holds all assertions the given assertionCreator creates for the subject as Iterable.

asList

fun <E> <ERROR CLASS><out Array<out E>>.asList(): <ERROR CLASS><List<E>>

Turns Expect<Array<E>> into Expect<List<E>>.

fun <E> <ERROR CLASS><Array<E>>.asList(assertionCreator: <ERROR CLASS><List<E>>.() -> Unit): <ERROR CLASS><Array<E>>
fun <ERROR CLASS><ByteArray>.asList(assertionCreator: <ERROR CLASS><List<Byte>>.() -> Unit): <ERROR CLASS><ByteArray>
fun <ERROR CLASS><CharArray>.asList(assertionCreator: <ERROR CLASS><List<Char>>.() -> Unit): <ERROR CLASS><CharArray>
fun <ERROR CLASS><ShortArray>.asList(assertionCreator: <ERROR CLASS><List<Short>>.() -> Unit): <ERROR CLASS><ShortArray>
fun <ERROR CLASS><IntArray>.asList(assertionCreator: <ERROR CLASS><List<Int>>.() -> Unit): <ERROR CLASS><IntArray>
fun <ERROR CLASS><LongArray>.asList(assertionCreator: <ERROR CLASS><List<Long>>.() -> Unit): <ERROR CLASS><LongArray>
fun <ERROR CLASS><FloatArray>.asList(assertionCreator: <ERROR CLASS><List<Float>>.() -> Unit): <ERROR CLASS><FloatArray>
fun <ERROR CLASS><DoubleArray>.asList(assertionCreator: <ERROR CLASS><List<Double>>.() -> Unit): <ERROR CLASS><DoubleArray>
fun <ERROR CLASS><BooleanArray>.asList(assertionCreator: <ERROR CLASS><List<Boolean>>.() -> Unit): <ERROR CLASS><BooleanArray>

Expects that the subject of the assertion holds all assertions the given assertionCreator creates for the subject as List.

fun <ERROR CLASS><ByteArray>.asList(): <ERROR CLASS><List<Byte>>

Turns Expect<CharArray> into Expect<List<Byte>>.

fun <ERROR CLASS><CharArray>.asList(): <ERROR CLASS><List<Char>>

Turns Expect<CharArray> into Expect<List<Char>>.

fun <ERROR CLASS><ShortArray>.asList(): <ERROR CLASS><List<Short>>

Turns Expect<ShortArray> into Expect<List<Short>>.

fun <ERROR CLASS><IntArray>.asList(): <ERROR CLASS><List<Int>>

Turns Expect<IntArray> into Expect<List<Int>>.

fun <ERROR CLASS><LongArray>.asList(): <ERROR CLASS><List<Long>>

Turns Expect<LongArray> into Expect<List<Double>>.

fun <ERROR CLASS><FloatArray>.asList(): <ERROR CLASS><List<Float>>

Turns Expect<FloatArray> into Expect<List<Float>>.

fun <ERROR CLASS><DoubleArray>.asList(): <ERROR CLASS><List<Double>>

Turns Expect<DoubleArray> into Expect<List<Double>>.

fun <ERROR CLASS><BooleanArray>.asList(): <ERROR CLASS><List<Boolean>>

Turns Expect<BooleanArray> into Expect<List<Boolean>>.

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.

cause

fun <TExpected : Throwable> <ERROR CLASS><out Throwable>.cause(): <ERROR CLASS><TExpected>

Expects that the property Throwable.cause of the subject is a TExpected (the same type or a sub-type), creates an Expect of the TExpected type for it and returns it.

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

Expects that the property Throwable.cause of the subject is a TExpected (the same type or a sub-type) and holds all assertions the given assertionCreator creates for it and returns this assertion container.

contains

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

Expects that the subject of the assertion (a CharSequence) 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>

Expects that the subject of the assertion (an Iterable) 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>

Expects that the subject of the assertion (an Iterable) 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>

Expects that the subject of the assertion (an Iterable) 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>

Expects that the subject of the assertion (a Map) 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>

Expects that the subject of the assertion (a Map) contains a key as defined by keyValue's KeyValue.key with a corresponding value which either holds all assertions keyValue's KeyValue.valueAssertionCreatorOrNull creates or needs to be null in case KeyValue.valueAssertionCreatorOrNull is defined as null -- optionally the same assertions are created for the otherKeyValues.

containsElementsOf

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsElementsOf(expectedIterable: Iterable<E>): <ERROR CLASS><T>

Expects that the subject of the assertion (an Iterable) contains all elements of expectedIterable.

containsExactly

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

Expects that the subject of the assertion (an Iterable) 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>

Expects that the subject of the assertion (an Iterable) 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>

Expects that the subject of the assertion (an Iterable) 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.

containsExactlyElementsOf

fun <E, T : Iterable<E>> <ERROR CLASS><T>.containsExactlyElementsOf(expectedIterable: Iterable<E>): <ERROR CLASS><T>

Expects that the subject of the assertion (an Iterable) contains only elements of expectedIterable in same order

containsKey

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

Expects that the subject of the assertion (a Map) contains the given key.

containsNot

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

Expects that the subject of the assertion (a CharSequence) 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>

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

containsNotKey

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

Expects that the subject of the assertion (a Map) does not contain the given key.

containsRegex

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

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

elementsOf

fun <T : CharSequence> <ERROR CLASS><T, <ERROR CLASS>>.elementsOf(expectedIterable: Iterable<Any>): <ERROR CLASS><T>

Finishes the specification of the sophisticated contains assertion where all elements of the expectedIterable shall be searched, using a non disjoint search.

fun <E, T : Iterable<E>> <ERROR CLASS><E, T, <ERROR CLASS>>.elementsOf(expectedIterable: Iterable<E>): <ERROR CLASS><T>

Finishes the specification of the sophisticated contains assertion where all elements of the expectedIterable shall be searched within the Iterable.

endsNotWith

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

Expects that the subject of the assertion (a CharSequence) does not end with expected.

endsWith

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

Expects that the subject of the assertion (a CharSequence) 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 creates 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 creates 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.

feature

fun <T, R> <ERROR CLASS><T>.feature(property: KProperty1<in T, R>): <ERROR CLASS><T, R>

Extracts the property out of the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, R> <ERROR CLASS><T>.feature(property: KProperty1<in T, R>, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the property out of the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, R> <ERROR CLASS><T>.feature(f: KFunction1<T, R>): <ERROR CLASS><T, R>

Extracts the value which is returned when calling f on the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, R> <ERROR CLASS><T>.feature(f: KFunction1<T, R>, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the value which is returned when calling f on the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, A1, R> <ERROR CLASS><T>.feature(f: KFunction2<T, A1, R>, a1: A1): <ERROR CLASS><T, R>

Extracts the value which is returned when calling f with argument a1 on the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, A1, R> <ERROR CLASS><T>.feature(f: KFunction2<T, A1, R>, a1: A1, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the value which is returned when calling f with argument a1 on the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, A1, A2, R> <ERROR CLASS><T>.feature(f: KFunction3<T, A1, A2, R>, a1: A1, a2: A2): <ERROR CLASS><T, R>

Extracts the value which is returned when calling f with arguments a1, a2 on the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, A1, A2, R> <ERROR CLASS><T>.feature(f: KFunction3<T, A1, A2, R>, a1: A1, a2: A2, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the value which is returned when calling f with argument a1, a2 on the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, A1, A2, A3, R> <ERROR CLASS><T>.feature(f: KFunction4<T, A1, A2, A3, R>, a1: A1, a2: A2, a3: A3): <ERROR CLASS><T, R>

Extracts the value which is returned when calling f with arguments a1, a2, a3 on the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, A1, A2, A3, R> <ERROR CLASS><T>.feature(f: KFunction4<T, A1, A2, A3, R>, a1: A1, a2: A2, a3: A3, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the value which is returned when calling f with argument a1, a2, a3 on the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, A1, A2, A3, A4, R> <ERROR CLASS><T>.feature(f: KFunction5<T, A1, A2, A3, A4, R>, a1: A1, a2: A2, a3: A3, a4: A4): <ERROR CLASS><T, R>

Extracts the value which is returned when calling f with arguments a1, a2, a3, a4 on the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, A1, A2, A3, A4, R> <ERROR CLASS><T>.feature(f: KFunction5<T, A1, A2, A3, A4, R>, a1: A1, a2: A2, a3: A3, a4: A4, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the value which is returned when calling f with argument a1, a2, a3, a4 on the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, A1, A2, A3, A4, A5, R> <ERROR CLASS><T>.feature(f: KFunction6<T, A1, A2, A3, A4, A5, R>, a1: A1, a2: A2, a3: A3, a4: A4, a5: A5): <ERROR CLASS><T, R>

Extracts the value which is returned when calling f with arguments a1, a2, a3, a4, a5 on the current subject of the assertion, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, A1, A2, A3, A4, A5, R> <ERROR CLASS><T>.feature(f: KFunction6<T, A1, A2, A3, A4, A5, R>, a1: A1, a2: A2, a3: A3, a4: A4, a5: A5, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts the value which is returned when calling f with argument a1, a2, a3, a4, a5 on the current subject of the assertion, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, R> <ERROR CLASS><T>.feature(description: String, provider: T.() -> R): <ERROR CLASS><T, R>

Extracts a feature out of the current subject of the assertion based on the given provider and using the given description, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, R> <ERROR CLASS><T>.feature(description: String, provider: T.() -> R, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts a feature out of the current subject of the assertion based on the given provider and using the given description, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

fun <T, R> <ERROR CLASS><T>.feature(provider: <ERROR CLASS><T>.(T) -> <ERROR CLASS><R>): <ERROR CLASS><T, R>

Extracts a feature out of the current subject of the assertion, based on the given provider, creates a new Expect for it and returns it so that subsequent calls are based on the feature.

fun <T, R> <ERROR CLASS><T>.feature(provider: <ERROR CLASS><T>.(T) -> <ERROR CLASS><R>, assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><T>

Extracts a feature out of the current subject of the assertion, based on the given provider, creates a new Expect for it, applies an assertion group based on the given assertionCreator for the feature and returns the initial Expect with the current subject.

first

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

Expects that the property Pair.first of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

get

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

Expects that the given index is within the bounds of the subject of the assertion (a List) and returns an Expect for the element at that position.

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

Expects that the given index is within the bounds of the subject of the assertion (a List) and that the element at that position holds all assertions the given assertionCreator creates for it.

getExisting

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

Expects that the subject of the assertion (a Map) contains the given key, creates an Expect for the corresponding value and returns the newly created assertion container, so that further fluent calls are assertions about it.

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

Expects that the subject of the assertion (a Map) contains the given key and that the corresponding value holds all assertions the given assertionCreator creates for it.

hasNext

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

Expects that the subject of the assertion (an Iterable) has at least one element.

hasNotNext

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

Expects that the subject of the assertion (an Iterable) does not have next element.

hasSize

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

Expects that the subject of the assertion (a Collection) has the given expected 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><out <ERROR CLASS>>.isA(): <ERROR CLASS><TSub>

Expects that the subject of the assertion is a TSub (the same type or a sub-type) and changes the subject to this type.

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

Expects that the subject of the assertion is a TSub (the same type or a sub-type) and that it holds all assertions the given assertionCreator creates.

isEmpty

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

Expects that the subject of the assertion (a CharSequence) CharSequence.kotlin.text.isEmpty.

isEqualIncludingScale

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

Expects that the subject of the assertion (a BigDecimal) is equal to expected including BigDecimal.scale.

isGreaterThan

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

Expects that the subject of the assertion is greater than expected. The comparison is carried out with Comparable.compareTo.

isGreaterThanOrEqual

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

Expects that the subject of the assertion is greater than or equal expected. The comparison is carried out with Comparable.compareTo.

isKeyValue

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

Expects that the property Map.Entry.key of the subject of the assertion is equal to the given key and the property Map.Entry.value is equal to the given value.

isLessThan

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

Expects that the subject of the assertion is less than expected. The comparison is carried out with Comparable.compareTo.

isLessThanOrEqual

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

Expects that the subject of the assertion is less than or equal expected. The comparison is carried out with Comparable.compareTo.

isNotBlank

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

Expects that the subject of the assertion (a CharSequence) CharSequence.kotlin.text.isNotBlank.

isNotEmpty

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

Expects that the subject of the assertion (a CharSequence) CharSequence.kotlin.text.isNotEmpty.

isNotEqualIncludingScale

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

Expects that the subject of the assertion (a BigDecimal) is not equal to expected including BigDecimal.scale.

isNotNumericallyEqualTo

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

Expects that the subject of the assertion (a BigDecimal) is not numerically equal to expected.

isNotSameAs

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

Expects that the subject of the assertion is not the same instance as expected.

isNumericallyEqualTo

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

Expects that the subject of the assertion (a BigDecimal) is numerically equal to expected.

isSameAs

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

Expects that the subject of the assertion is the same instance as expected.

key

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

Expects that the property Map.Entry.key of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

keys

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

Expects that the property Map.keys of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

matches

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

Expects that the subject of the assertion (a CharSequence) matches the given expected.

max

fun <E : Comparable<E>, T : Iterable<E>> <ERROR CLASS><T>.max(): <ERROR CLASS><E>

Creates an Expect for the result of calling max() on the subject of the assertion, so that further fluent calls are assertions about it.

fun <E : Comparable<E>, T : Iterable<E>> <ERROR CLASS><T>.max(assertionCreator: <ERROR CLASS><E>.() -> Unit): <ERROR CLASS><T>

Expects that the result of calling max() on the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

message

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

Expects that the property Throwable.message of the subject of the assertion is not null and holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

messageContains

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

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

min

fun <E : Comparable<E>, T : Iterable<E>> <ERROR CLASS><T>.min(): <ERROR CLASS><E>

Creates an Expect for the result of calling min() on the subject of the assertion, so that further fluent calls are assertions about it.

fun <E : Comparable<E>, T : Iterable<E>> <ERROR CLASS><T>.min(assertionCreator: <ERROR CLASS><E>.() -> Unit): <ERROR CLASS><T>

Expects that the result of calling min() on the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

mismatches

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

Expects that the subject of the assertion (a CharSequence) mismatches the given expected.

none

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

Expects that the subject of the assertion (an Iterable) 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.

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> <ERROR CLASS><T>.notToBe(expected: T): <ERROR CLASS>

Expects that the subject of the assertion is not (equal to) expected.

notToBeNull

fun <T : Any> <ERROR CLASS><T?>.notToBeNull(): <ERROR CLASS><T>

Expects that the subject of the assertion is not null and changes the subject to the non-nullable version.

fun <T : Any> <ERROR CLASS><T?>.notToBeNull(assertionCreator: <ERROR CLASS><T>.() -> Unit): <ERROR CLASS><T>

Expects that the subject of the assertion is not null and that it holds all assertions the given assertionCreator creates.

notToThrow

fun <R, T : () -> R> <ERROR CLASS><T>.notToThrow(): <ERROR CLASS><R>

Expects that no Throwable is thrown at all when calling the subject (a lambda with arity 0, i.e. without arguments) and changes the subject of the assertion to the return value of type R.

fun <R, T : () -> R> <ERROR CLASS><T>.notToThrow(assertionCreator: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>

Expects that no Throwable is thrown at all when calling the subject (a lambda with arity 0, i.e. without arguments) and that the corresponding return value holds all assertions the given assertionCreator creates.

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.

fun <T : CharSequence> <ERROR CLASS><T, <ERROR CLASS>>.regex(pattern: Regex, vararg otherPatterns: Regex): <ERROR CLASS><T>

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

second

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

Expects that the property Pair.second of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

size

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

Expects that the property Collection.size of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

startsNotWith

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

Expects that the subject of the assertion (a CharSequence) does not start with expected.

startsWith

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

Expects that the subject of the assertion (a CharSequence) starts with expected.

toBe

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

Expects that the subject of the assertion is (equal to) expected.

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

Expects that the subject of the assertion (a BigDecimal) is null.

toBeNullIfNullGivenElse

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

Expects that the subject of the assertion is either null in case assertionCreatorOrNull is null or is not null and holds all assertions assertionCreatorOrNull creates.

toBeWithErrorTolerance

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

Expects that the subject of the assertion (a Float) is equal to expected with an error tolerance (range including bounds).

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

Expects that the subject of the assertion (a Double) is equal to expected with an error tolerance (range including bounds).

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

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

toThrow

fun <TExpected : Throwable> <ERROR CLASS><() -> Any?>.toThrow(): <ERROR CLASS><TExpected>

Expects that the thrown Throwable is a TExpected (the same type or a sub-type).

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

Expects that the thrown Throwable is a TExpected (the same type or a sub-type) and that it holds all assertions the given assertionCreator creates.

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, T : Entry<K, V>> <ERROR CLASS><T>.value(assertionCreator: <ERROR CLASS><V>.() -> Unit): <ERROR CLASS><T>

Expects that the property Map.Entry.value of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

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><T>

Expects that the property Map.keys of the subject of the assertion holds all assertions the given assertionCreator creates for it and returns an Expect for the current subject of the assertion.

withOptions

fun <T> <ERROR CLASS><T>.withOptions(configuration: <ERROR CLASS><T>.() -> Unit): <ERROR CLASS><T>
fun <T, R> <ERROR CLASS><T, R>.withOptions(configuration: <ERROR CLASS><R>.() -> Unit): <ERROR CLASS><R>

Uses the given configuration-lambda to create an ExpectOptions which in turn is used to override (parts) of the existing configuration.

fun <T> <ERROR CLASS><T>.withOptions(options: <ERROR CLASS><T>): <ERROR CLASS><T>
fun <T, R> <ERROR CLASS><T, R>.withOptions(options: <ERROR CLASS><R>): <ERROR CLASS><R>

Uses the given options to override (parts) of the existing configuration.

withRepresentation

fun <T> <ERROR CLASS><T>.withRepresentation(textRepresentation: String): <ERROR CLASS><T>
fun <T, R> <ERROR CLASS><T, R>.withRepresentation(textRepresentation: String): <ERROR CLASS><R>

Wraps the given textRepresentation into a RawString and uses it as representation of the subject instead of the representation that has been defined so far (which defaults to the subject itself).

fun <T> <ERROR CLASS><T>.withRepresentation(representationProvider: (T) -> Any): <ERROR CLASS><T>
fun <T, R> <ERROR CLASS><T, R>.withRepresentation(representationProvider: (R) -> Any): <ERROR CLASS><R>

Uses the given representationProvider to retrieve a representation which can be based on the current subject where it is used as new representation of the subject instead of the representation that has been defined so far (which defaults to the subject itself).