doc / ch.tutteli.atrium.domain.creating.charsequence.contains / CharSequenceContains

CharSequenceContains

interface CharSequenceContains
Deprecated: Use the CharSequenceContains from atrium-logic; will be removed with 1.0.0

Defines the contract for sophisticated CharSequence builders.

The building process is typically started by the creation of a Builder, goes on by specifying a desired SearchBehaviour, defines which Checkers should be applied and is finalized by one of the CharSequenceContainsAssertions which usually use a Creator which in turn use a Searcher.

Types

Builder

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

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 : Contains.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 : CharSequence, out S : CharSequenceContains.SearchBehaviour> : Contains.CheckerOption<T, S, CharSequenceContains.Checker, CharSequenceContains.Builder<T, S>>

The step of choosing/defining Checkers.

Creator

interface Creator<in T : CharSequence, in SC> : Contains.Creator<T, SC>

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

SearchBehaviour

interface SearchBehaviour : Contains.SearchBehaviour

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

Searcher

interface Searcher<S : CharSequenceContains.SearchBehaviour, SC>

Represents a searcher which supports the search behaviour S for a given input CharSequence of the search.