doc / ch.tutteli.atrium.domain.creating.basic.contains / Contains

Contains

interface Contains

Defines the basic contract for sophisticated contains assertion builders.

The entry point for the contract constitutes a Contains.Builder. A builder typically allows a user to choose a desired SearchBehaviour, one or more Checkers and uses an Creator to finish the building process.

Types

Builder

interface Builder<out T : Any, out S : Contains.SearchBehaviour>

The entry point of the contract, containing the subjectProvider -- i.e. the subject of the assertion for which the sophisticated contain assertion should be created -- as well as the chosen searchBehaviour.

Checker

interface Checker

Represents a check for the search result such as: the object is contained exactly once in the input of the search.

CheckerOption

interface CheckerOption<out T : Any, out S : Contains.SearchBehaviour, out C : Contains.Checker, out B : Contains.Builder<T, S>>

The step of choosing/defining Checkers.

Creator

interface Creator<in T : Any, in SC>

Represents the final step of a sophisticated contains assertion builder which creates the AssertionGroup as such.

SearchBehaviour

interface SearchBehaviour

Represents a search behaviour but leaves it up to the Creator how this behaviour is implemented -- yet, it provides a method to decorate a description (a Translatable) in order that it reflects the search behaviour.