doc / ch.tutteli.atrium.api.fluent.en_GB / value

value

fun <T : CharSequence> CharSequenceContains.CheckerStep<T, NoOpSearchBehaviour>.value(expected: CharSequenceOrNumberOrChar): Expect<T> (source)

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

Delegates to values.

Notice that a runtime check applies which assures that only CharSequence, Number and Char are passed. This function expects CharSequenceOrNumberOrChar (which is a typealias for 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.

Parameters

expected - The value which is expected to be contained within the input of the search.

Exceptions

IllegalArgumentException - in case expected is not a CharSequence, Number or Char.

Return
an Expect for the subject of this expectation.

@JvmName("valueIgnoringCase") fun <T : CharSequence> CharSequenceContains.CheckerStep<T, IgnoringCaseSearchBehaviour>.value(expected: CharSequenceOrNumberOrChar): Expect<T> (source)

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

Delegates to values(expected).

Notice that a runtime check applies which assures that only CharSequence, Number and Char are passed. This function expects CharSequenceOrNumberOrChar (which is a typealias for 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.

Parameters

expected - The value which is expected to be contained within the input of the search.

Exceptions

IllegalArgumentException - in case expected is not a CharSequence, Number or Char.

Return
an Expect for the subject of this expectation.

fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.value(expected: CharSequenceOrNumberOrChar): Expect<T> (source)

Finishes the specification of the sophisticated contains assertion where the expected value shall be searched (ignoring case), using a non disjoint search where it needs to be contained at least once.

Delegates to atLeast(1).value(expected).

Notice that a runtime check applies which assures that only CharSequence, Number and Char are passed. This function expects CharSequenceOrNumberOrChar (which is a typealias for 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.

Parameters

expected - The value which is expected to be contained within the input of the search.

Exceptions

IllegalArgumentException - in case expected is not a CharSequence, Number or Char.

Return
an Expect for the subject of this expectation.

fun <E, T> IterableLikeContains.CheckerStep<E, T, InAnyOrderSearchBehaviour>.value(expected: E): Expect<T> (source)

Finishes the specification of the sophisticated contains assertion where the subject (an IterableLike) needs to contain the expected value.

Delegates to values.

Parameters

expected - The value which is expected to be contained within this IterableLike.

Return
an Expect for the subject of this expectation.

Since
0.14.0 -- API existed for Iterable but not for IterableLike.

fun <E, T> IterableLikeContains.EntryPointStep<E, T, InAnyOrderOnlySearchBehaviour>.value(expected: E): Expect<T> (source)
fun <E, T> IterableLikeContains.EntryPointStep<E, T, InOrderOnlySearchBehaviour>.value(expected: E): Expect<T> (source)

Finishes the specification of the sophisticated contains assertion where the subject (an IterableLike) needs to contain only the expected value.

Delegates to values.

Note that we might change the signature of this function with the next version which will cause a binary backward compatibility break (see #292 for more information)

Parameters

expected - The value which is expected to be contained within the subject (an IterableLike).

Return
an Expect for the subject of this expectation.

Since
0.14.0 -- API existed for Iterable but not for IterableLike.

fun <K, V, T : Entry<K, V>> Expect<T>.value(assertionCreator: Expect<V>.() -> Unit): Expect<T> (source)

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

expect(mapOf(1 to "a").entries.first())
    .value {    // subject inside this block is of type String (actually "a")
        toBe("a")
    }

fails {
    expect(mapOf(1 to "a").entries.first())
        .value {    // subject inside this block is of type String (actually "a")
            toBe("b")   // fails because "a" is not equal to "b"
        }
}

Return
an Expect for the subject of this expectation.

val <V, T : Entry<*, V>> Expect<T>.value: Expect<V> (source)

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

expect(mapOf(1 to "a").entries.first())
    .value  // subject here is of type String (actually "a")
    .toBe("a")

fails {
    expect(mapOf(1 to "a").entries.first())
        .value  // subject here is of type String (actually "a")
        .toBe("b")  // fails because "a" is not equal to "b"
}

Return
The newly created Expect for the extracted feature.