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

EntryPointStep

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

(source)

The entry point of the contract. Use _logic to retrieve the EntryPointStepLogic counterpart in case you want to extend the building process.

Extension Properties

_logic	`val <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>._logic: CharSequenceContains.EntryPointStepLogic<T, S>` Entry point to the logic level of Atrium -- which is one level deeper than the API -- within the building process of a sophisticated `contains` assertion for CharSequence.
ignoringCase	`val <T : CharSequence> CharSequenceContains.EntryPointStep<T, NoOpSearchBehaviour>.ignoringCase: CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>` Defines that the v behaviour `ignore case` shall be applied to this sophisticated `contains` assertion.

Extension Functions

atLeast	`fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.atLeast(times: Int): AtLeastCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `at least` number of times within the search input.
atLeast	`infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.atLeast(times: Int): AtLeastCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `at least` number of times within the search input.
atMost	`fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.atMost(times: Int): AtMostCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `at least` once but `at most` number of times within the search input.
atMost	`infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.atMost(times: Int): AtMostCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `at least` once but `at most` number of times within the search input.
elementsOf	`fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.elementsOf(expectedIterableLike: IterableLike): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where all elements of the expectedIterableLike shall be searched (ignoring case), using a non-disjoint search.
elementsOf	`infix fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.elementsOf(expectedIterableLike: IterableLike): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where all elements of the expectedIterableLike shall be searched (ignoring case), using a non-disjoint search.
exactly	`fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.exactly(times: Int): ExactlyCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `exactly` number of times within the search input.
exactly	`infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.exactly(times: Int): ExactlyCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `exactly` number of times within the search input.
ignoring	`infix fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, NoOpSearchBehaviour>.ignoring(case: case): CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>` Defines that the search behaviour `ignore case` shall be applied to this sophisticated `contains` assertion.
notOrAtMost	`fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.notOrAtMost(times: Int): NotOrAtMostCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `not at all or at most` number of times within the search input.
notOrAtMost	`infix fun <T : CharSequence, S : CharSequenceContains.SearchBehaviour> CharSequenceContains.EntryPointStep<T, S>.notOrAtMost(times: Int): NotOrAtMostCheckerStep<T, S>` Restricts a `contains` assertion by specifying that the number of occurrences of the value which we are looking for occurs `not at all or at most` number of times within the search input.
regex	`fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.regex(pattern: String, vararg otherPatterns: String): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where the given regular expression pattern as well as the otherPatterns are expected to to have at least one match (ignoring case), using a non-disjoint search.
regex	`infix fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.regex(pattern: String): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where the given regular expression pattern is expected to have at least one match (ignoring case), using a non-disjoint search.
the	`infix fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.the(values: Values<CharSequenceOrNumberOrChar>): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where the values shall be searched (ignoring case), using a non-disjoint search where each need to be contained at least once. `infix fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.the(patterns: RegexPatterns): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where the given regular expression patterns are expected to have at least one match (ignoring case), using a non-disjoint search.
value	`fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.value(expected: CharSequenceOrNumberOrChar): Expect<T>` 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.
value	`infix fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.value(expected: CharSequenceOrNumberOrChar): Expect<T>` 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.
values	`fun <T : CharSequence> CharSequenceContains.EntryPointStep<T, IgnoringCaseSearchBehaviour>.values(expected: CharSequenceOrNumberOrChar, vararg otherExpected: CharSequenceOrNumberOrChar): Expect<T>` Finishes the specification of the sophisticated `contains` assertion where the expected value as well as the otherExpected values shall be searched (ignoring case), using a non-disjoint search where each need to be contained at least once.

Inheritors

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.