doc / ch.tutteli.atrium.api.cc.de_CH / enthaelt

enthaelt

val <T : CharSequence> Assert<T>.enthaelt: Builder<T, NoOpSearchBehaviour> (source)

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

Return
The newly created builder.

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

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

It is a shortcut for enthaelt.zumindest(1).werte(expected, *otherExpected).

Notice that a runtime check applies which assures that only CharSequence, Number and Char are passed (this function expects Any for your convenience, so that you can mix String and Int for instance).

By non disjoint is meant that 'aa' in 'aaaa' is found three times and not only two times. Also notice, that it does not search for unique matches. Meaning, if the input of the search is 'a' and expected is defined as 'a' and one otherExpected is defined as 'a' as well, then both match, even though they match the same sequence in the input of the search. Use the property enthaelt to create a more sophisticated contains assertion where you can use options such as zumindest, hoechstens and genau to control the number of occurrences you expect.

Meaning you might want to use: enthaelt.genau(2).wert('a') instead of: enthaelt('a', 'a')

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

IllegalArgumentException - in case expected or one of the otherExpected is not a CharSequence, Number or Char.

Return
This plant to support a fluent API.

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

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

It is a shortcut for enthaelt.inBeliebigerReihenfolge.zumindest(1).werte(expected, *otherExpected)

Notice, that it does not search for unique matches. Meaning, if the iterable is setOf('a', 'b') and expected is defined as 'a' and one otherExpected is defined as 'a' as well, then both match, even though they match the same entry. Use an option such as zumindest, hoechstens and genau to control the number of occurrences you expect.

Meaning you might want to use: enthaelt.inBeliebigerReihenfolge.genau(2).wert('a') instead of: enthaelt('a', 'a')

This function will be renamed on a JVM level from enthaeltNonNullable to enthaelt with 1.0.0

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

Return
This plant to support a fluent API.

fun <E : Any, T : Iterable<E>> Assert<T>.enthaelt(assertionCreator: Assert<E>.() -> Unit): <ERROR CLASS> (source)

Makes the assertion that AssertionPlant.subject contains an entry holding the assertions created by the assertionCreator.

It is a shortcut for enthaelt.inBeliebigerReihenfolge.zumindest(1).eintrag(assertionCreator)

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

Return
This plant to support a fluent API.

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

Makes the assertion that AssertionPlant.subject contains an entry holding the assertions created by the assertionCreator -- likewise an entry (can be the same) is searched for each of the otherAssertionCreators.

It is a shortcut for enthaelt.inBeliebigerReihenfolge.zumindest(1).eintraege(assertionCreator, *otherAssertionCreators)

Exceptions

AssertionError - Might throw an AssertionError if the assertion made is not correct.

Return
This plant to support a fluent API.