doc

KDoc of Atrium

Atrium is built up by different modules, each available for different platforms.

The following names do not include the platform specific suffixes which are -common, -jvm, and -js.

Bundle modules:

API modules:

Logic modules:

Core modules:

Translation modules:

Misc modules:

Packages

ch.tutteli.atrium.api.fluent.en_GB

Contains API which provides a pure fluent API in English and which has its design focus on usability in conjunction with code completion.

ch.tutteli.atrium.api.fluent.en_GB.creating.feature

Contains the MetaFeatureOptions which is used feature.

ch.tutteli.atrium.api.fluent.en_GB.kotlin_1_3

Contains an API for types introduced with Kotlin 1.3

ch.tutteli.atrium.api.infix.en_GB

Contains API which provides an infix API in English and which has its design focus on usability in conjunction with code completion.

ch.tutteli.atrium.api.infix.en_GB.creating

Contains parameter objects .

ch.tutteli.atrium.api.infix.en_GB.creating.feature

Contains parameter objects related to feature extraction.

ch.tutteli.atrium.api.infix.en_GB.creating.iterable

Contains parameter objects related to Iterable.

ch.tutteli.atrium.api.infix.en_GB.creating.map

Contains parameter objects related to Map.

ch.tutteli.atrium.api.infix.en_GB.creating.path

Contains parameter objects related to Path.

ch.tutteli.atrium.api.infix.en_GB.kotlin_1_3

Contains an API for types introduced with Kotlin 1.3

ch.tutteli.atrium.api.infix.en_GB.workaround

Contains functions necessary for the infix API to work due to Kotlin related bugs / or insufficient type inference capabilities .

ch.tutteli.atrium.api.verbs

Contains the out-of-the-box expectation verb expect.

ch.tutteli.atrium.assertions

Contains different types of Assertion, e.g. DescriptiveAssertion. Currently, it contains also @Deprecated types which will be made internal with 0.17.0 or earlier

ch.tutteli.atrium.assertions.builders

The AssertionBuilder and other builders to ease the creation of Assertions.

ch.tutteli.atrium.assertions.builders.common

Package containing/defining common steps for builders.

ch.tutteli.atrium.core

Contains the CoreFactory.

ch.tutteli.atrium.core.migration

Contains helper functions which shall ease the migration to a newer version of Atrium. For instance, it contains toAtriumLocale to convert a Java Locale to an Atrium specific and platform independent representation of an Locale.

ch.tutteli.atrium.core.polyfills

Contains polyfills for functionality which is missing on certain platforms so that they can be used in a common way.

ch.tutteli.atrium.creating

Everything involved in creating Assertions.

ch.tutteli.atrium.creating.feature

Contains feature related contracts, such as FeatureInfo which is responsible to determine the description of a feature extraction.

ch.tutteli.atrium.creating.feature.impl

Contains (default) implementations for feature related contracts.

ch.tutteli.atrium.creating.impl

Contains (default) implementations for things like Expect.

ch.tutteli.atrium.logic

Contains all the assertion interfaces (e.g. AnyAssertions as well as _logic and helper functions for AssertionContainer

ch.tutteli.atrium.logic.assertions.impl

Contains internal implementations of Assertion.

ch.tutteli.atrium.logic.creating

Contains builders which help in creating different types of Expect.

ch.tutteli.atrium.logic.creating.basic.contains

Contains the abstract contract sophisticated contains assertion builders: Contains

ch.tutteli.atrium.logic.creating.basic.contains.checkers

Contains interfaces implementing Contains.Checker

ch.tutteli.atrium.logic.creating.basic.contains.checkers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.basic.contains.checkers.

ch.tutteli.atrium.logic.creating.basic.contains.creators.impl

Contains base classes which can be handy to implement Contains.Creator

ch.tutteli.atrium.logic.creating.basic.contains.steps.impl

Contains base classes which can be handy to implement steps of the building process.

ch.tutteli.atrium.logic.creating.charsequence.contains

Contains the contract for sophisticated CharSequence.contains assertion builders: CharSequenceContains

ch.tutteli.atrium.logic.creating.charsequence.contains.checkers

Contains interfaces implementing CharSequenceContains.Checker

ch.tutteli.atrium.logic.creating.charsequence.contains.checkers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.checkers.

ch.tutteli.atrium.logic.creating.charsequence.contains.creators

Contains inter alia CharSequenceContains.Creators as well as the minimum set of functions which are intended to be used as part of the final step of the building process.

ch.tutteli.atrium.logic.creating.charsequence.contains.creators.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.creators.

ch.tutteli.atrium.logic.creating.charsequence.contains.searchbehaviours

Contains interfaces implementing CharSequenceContains.SearchBehaviour

ch.tutteli.atrium.logic.creating.charsequence.contains.searchbehaviours.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.searchbehaviours.

ch.tutteli.atrium.logic.creating.charsequence.contains.searchers.impl

Contains implementations of CharSequenceContains.Searcher

ch.tutteli.atrium.logic.creating.charsequence.contains.steps

Contains steps for sophisticated CharSequence.contains expectation builders.

ch.tutteli.atrium.logic.creating.charsequence.contains.steps.impl

Contains the default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.steps.

ch.tutteli.atrium.logic.creating.collectors

Contains helper functions to collection Assertions.

ch.tutteli.atrium.logic.creating.feature

Contains interfaces which are used in the building process of feature extractors.

ch.tutteli.atrium.logic.creating.filesystem

Contains constracts / data structures which help in dealing with file-IO.

ch.tutteli.atrium.logic.creating.filesystem.hints

Contains helper functions which help in defining failure hints in case your expectation function deals with the file system.

ch.tutteli.atrium.logic.creating.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.

ch.tutteli.atrium.logic.creating.iterable.contains

Contains the contract for sophisticated IterableLike.contains expectation builders: IterableLikeContains

ch.tutteli.atrium.logic.creating.iterable.contains.checkers

Contains interfaces implementing IterableLikeContains.Checker

ch.tutteli.atrium.logic.creating.iterable.contains.checkers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.iterable.contains.checkers.

ch.tutteli.atrium.logic.creating.iterable.contains.creators

Contains inter alia IterableLikeContains.Creators as well as the minimum set of functions which are intended to be used as part of the final step of the building process.

ch.tutteli.atrium.logic.creating.iterable.contains.creators.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.iterable.contains.creators.

ch.tutteli.atrium.logic.creating.iterable.contains.searchbehaviours

Contains interfaces implementing IterableLikeContains.SearchBehaviour

ch.tutteli.atrium.logic.creating.iterable.contains.searchbehaviours.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.iterable.contains.searchbehaviours.

ch.tutteli.atrium.logic.creating.iterable.contains.steps

Contains steps for sophisticated IterableLike.contains expectation builders.

ch.tutteli.atrium.logic.creating.iterable.contains.steps.impl

Contains the default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.iterable.contains.steps.

ch.tutteli.atrium.logic.creating.iterablelike.contains.reporting

Reporting related interfaces for IterableLike.contains.

ch.tutteli.atrium.logic.creating.maplike.contains

Contains the contract for sophisticated MapLike.contains expectation builders: MapLikeContains

ch.tutteli.atrium.logic.creating.maplike.contains.checkers

Contains interfaces implementing MapLikeContains.Checker

ch.tutteli.atrium.logic.creating.maplike.contains.checkers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.maplike.contains.checkers.

ch.tutteli.atrium.logic.creating.maplike.contains.creators

Contains inter alia MapLikeContains.Creators as well as the minimum set of functions which are intended to be used as part of the final step of the building process.

ch.tutteli.atrium.logic.creating.maplike.contains.creators.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.maplike.contains.creators.

ch.tutteli.atrium.logic.creating.maplike.contains.searchbehaviours

Contains interfaces implementing MapLikeContains.SearchBehaviour

ch.tutteli.atrium.logic.creating.maplike.contains.searchbehaviours.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.maplike.contains.searchbehaviours.

ch.tutteli.atrium.logic.creating.maplike.contains.steps

Contains steps for sophisticated MaplikeLike.contains expectation builders.

ch.tutteli.atrium.logic.creating.maplike.contains.steps.impl

Contains the default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.maplike.contains.steps.

ch.tutteli.atrium.logic.creating.transformers

Contains contracts involved in transforming Expect, their subject respectively.

ch.tutteli.atrium.logic.creating.transformers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.transformers.

ch.tutteli.atrium.logic.creating.transformers.impl.featureextractor

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.transformers specific to feature extraction.

ch.tutteli.atrium.logic.creating.transformers.impl.subjectchanger

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.transformers specific to subject changing.

ch.tutteli.atrium.logic.creating.typeutils

Contains type alias used in Atrium to better describe the intent behind the types.

ch.tutteli.atrium.logic.creating.typeutils.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.typeutils.impl specific to subject changing.

ch.tutteli.atrium.logic.impl

Contains default implementations of the assertion interfaces defined in ch.tutteli.atrium.logic.

ch.tutteli.atrium.logic.kotlin_1_3

Contains all the assertion interfaces for the Kotlin 1.3 extension (e.g. ResultAssertions

ch.tutteli.atrium.logic.kotlin_1_3.impl

Contains default implementations of the assertion interfaces defined in ch.tutteli.atrium.logic.kotlin_1_3.

ch.tutteli.atrium.logic.utils

Contains inter alia the mapArgument function next to other helper functions such as nullable and co.

ch.tutteli.atrium.reporting

Everything involved in reporting Assertions.

ch.tutteli.atrium.reporting.erroradjusters

Contains marker interfaces for different kinds of AtriumErroAdjusters.

ch.tutteli.atrium.reporting.erroradjusters.impl

Contains default implementations of the interfaces defined in ch.tutteli.atrium.reporting.erroradjusters.

ch.tutteli.atrium.reporting.impl

Contains default implementations of the interfaces defined in ch.tutteli.atrium.reporting.

ch.tutteli.atrium.reporting.text

Text specific, in other words terminal specific, reporting contracts.

ch.tutteli.atrium.reporting.text.impl

Contains default implementations of the interfaces defined in ch.tutteli.atrium.reporting.text.

ch.tutteli.atrium.reporting.translating

Everything involved in translating Translatables.

ch.tutteli.atrium.reporting.translating.impl

Contains default implementations of the interfaces defined in ch.tutteli.atrium.reporting.translating.

ch.tutteli.atrium.translations

Contains Translatables.

Index

All Types