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

CharSequenceContains

interface CharSequenceContains

Defines the contract for sophisticated CharSequence contains assertion builders.

The building process is typically started by the creation of a EntryPointStep, 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 uses a Searcher.

Types

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.
CheckerStep	`interface CheckerStep<T : CharSequence, out S : CharSequenceContains.SearchBehaviour> : Contains.CheckerStep<T, S, CharSequenceContains.Checker, CharSequenceContains.EntryPointStep<T, S>>` The step of choosing/defining Checkers.
CheckerStepInternal	`interface CheckerStepInternal<T : CharSequence, out S : CharSequenceContains.SearchBehaviour> : CharSequenceContains.CheckerStep<T, S>, CharSequenceContains.CheckerStepLogic<T, S>` Sole purpose of this interface is to hide CheckerStepLogic from newcomers which usually don't have to deal with this type and to keep the API clean.
CheckerStepLogic	`interface CheckerStepLogic<T : CharSequence, out S : CharSequenceContains.SearchBehaviour> : Contains.CheckerStepLogic<T, S, CharSequenceContains.Checker, CharSequenceContains.EntryPointStepLogic<T, S>>` The step of choosing/defining Checkers on the logic level.
Creator	`interface Creator<T : CharSequence, in SC> : Contains.Creator<T, SC>` Represents the final step of a sophisticated `contains` assertion builder which creates the AssertionGroup as such.
EntryPointStep	`interface EntryPointStep<T : CharSequence, out S : CharSequenceContains.SearchBehaviour> : Contains.EntryPointStep<T, S>` The entry point of the contract. Use `_logic` to retrieve the EntryPointStepLogic counterpart in case you want to extend the building process.
EntryPointStepInternal	`interface EntryPointStepInternal<T : CharSequence, out S : CharSequenceContains.SearchBehaviour> : CharSequenceContains.EntryPointStep<T, S>, CharSequenceContains.EntryPointStepLogic<T, S>` Sole purpose of this interface is to hide EntryPointStepLogic from newcomers which usually do not have to deal with this type and to keep the API clean.
EntryPointStepLogic	`interface EntryPointStepLogic<T : CharSequence, out S : CharSequenceContains.SearchBehaviour> : Contains.EntryPointStepLogic<T, S>` The entry point of the contract on the logic level, containing the container -- i.e. the subject of the assertion for which the sophisticated `contain` assertion should be created -- as well as the chosen searchBehaviour.
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.