Atrium 0.9.0

doc

KDoc of Atrium

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

The packages shown below contain classes etc. of all modules excluding the one of atrium-core-robstoll, atrium-core-robstoll-lib, atrium-domain-robstoll and atrium-domain-robstoll-lib.

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

Bundle modules:

atrium-fluent-en_GB defines to have a dependency on atrium-api-fluent-en_GB, atrium-translations-en_GB, atrium-domain-robstoll and and atrium-core-robstoll
atrium-cc-infix-en_GB-robstoll defines to have a dependency on atrium-api-cc-infix-en_GB, atrium-translations-en_GB, atrium-domain-robstoll and and atrium-core-robstoll

API modules:

atrium-api-fluent-en_GB provides an assertion function API in English where the main focus of this API's design is put on ease of use/compatibility with code completion functionality of an IDE. It is a pure fluent API. extensions:
- atrium-api-fluent-en_GB-jdk8 provides additional assertion functions for types introduced with JDK 8 (e.g. for Path)
- atrium-api-fluent-en_GB-kotlin_1_3 provides additional assertion functions for types introduced in Kotlin 1.3 (e.g. for Result)
atrium-api-cc-infix-en_GB provides an assertion function API in English where the main focus of this API's design is put on ease of use/compatibility with code completion functionality of an IDE. It is an infix API.

Domain modules:

atrium-domain-api defines the contracts of the domain of Atrium (contracts for impl-functions and sophisticated assertion builders).
atrium-domain-robstoll provides the different domain services like CharSequenceAssertions which use the implementations of atrium-domain-robstoll-lib
atrium-domain-robstoll-lib robstoll's implementation of the domain of Atrium.
atrium-domain-builders contains AssertImpl, the ReporterBuilder and last but not least provides base classes of sophisticated assertion builders for the API modules.

Core modules:

atrium-core-api defines the contracts of the core of Atrium.
atrium-core-robstoll provides an implementation for CoreFactory which uses the implementations of atrium-core-robstoll-lib
atrium-core-robstoll-lib robstoll's implementation of the core of Atrium.

Translation modules:

atrium-translations-de_CH provides translations in German for Translatables used in assertion functions.
atrium-translations-en_GB provides translations in English for Translatables used in assertion functions.

Misc modules:

atrium-spec contains Spek specifications for interfaces (defined in atrium-core-api) and assertion functions. The specifications can be reused by implementation of the core of Atrium as well as by API implementations to assure they fulfill the specifications.
atrium-verbs contains out of the box assertion verbs
atrium-verbs-internal contains the assertion verbs Atrium uses internally - use with care, no backward compatibility guarantees.

Atrium has currently several modules to retain backward compatibility. You should not rely on them and move to the suggested predecessor:

atrium-cc-de_CH-robstoll use atrium-fluent-de_CH instead. This bundle defines to have a dependency on atrium-api-cc-de_CH, atrium-translations-de_CH, atrium-domain-robstoll and atrium-core-robstoll
atrium-cc-en_GB-robstoll use atrium-fluent-en_GB instead. This bundle defines to have a dependency on atrium-api-cc-en_GB, atrium-translations-en_GB, atrium-domain-robstoll and and atrium-core-robstoll
atrium-cc-en_UK-robstoll use atrium-cc-en_GB-robstoll instead. This bundle defines to have a dependency on atrium-api-cc-en_UK, atrium-translations-en_UK, atrium-domain-robstoll, atrium-core-robstoll and some deprecated modules
atrium-cc-infix-en_UK-robstoll use atrium-cc-infix-en_GB-robstoll instead. This bundle defines to have a dependency on atrium-api-cc-infix-en_UK, atrium-translations-en_UK, atrium-domain-robstoll, atrium-core-robstoll and some deprecated modules
atrium-api-cc-de_CH use atrium-api-fluent-de_CH instead.
atrium-api-cc-en_GB use atrium-api-fluent-en_GB instead.
atrium-api-cc-infix-en_GB use atrium-api-infix-en_GB instead.
atrium-api-cc-en_UK use atrium-api-cc-en_GB instead.
atrium-domain-api-deprecated contains deprecated domain-api code
atrium-core-robstoll-deprecated contains the deprecated AtriumFactory => use coreFactory instead
atrium-assertions is deprecated and you should not longer rely on it. It will be removed with 1.0.0. Use the replacements suggested in the @Deprecated annotations.

Packages

ch.tutteli.atrium	Contains the `@Deprecated` IAtriumFactory.
ch.tutteli.atrium.api.cc.de_CH	`@Deprecated` API use ch.tutteli.atrium.api.fluent.de_CH instead.
ch.tutteli.atrium.api.cc.de_CH.assertions.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.de_CH.assertions.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.de_CH.creating.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `fluent.de_CH`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.de_CH.creating.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `fluent.de_CH`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.en_GB	`@Deprecated` API use ch.tutteli.atrium.api.fluent.en_GB instead.
ch.tutteli.atrium.api.cc.en_GB.creating.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `fluent.en_GB`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.en_GB.creating.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `fluent.en_GB`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.en_UK	`@Depreacted` API use ch.tutteli.atrium.api.fluent.en_GB instead.
ch.tutteli.atrium.api.cc.en_UK.assertions.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.en_UK.assertions.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.en_UK.creating.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `en_GB`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.en_UK.creating.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `en_GB`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_GB	`@Depreacted` API use ch.tutteli.atrium.api.infix.en_GB instead.
ch.tutteli.atrium.api.cc.infix.en_GB.creating.charsequence.contains.builders	Contains `@Deprecated` builders, switch from package `cc.infix` to `infix`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_GB.creating.iterable.contains.builders	Contains `@Deprecated` builders, switch from package `cc.infix` to `infix`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_GB.creating.list.get.builders	Contains `@Deprecated` builders, switch from package `cc.infix` to `infix`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_GB.creating.map.get.builders	Contains `@Deprecated` builders, switch from package `cc.infix` to `infix`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_GB.keywords	Contains `@Deprecated` pseudo keywords, switch from package `cc.infix` to `infix`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_UK	`@Depreacted` API use ch.tutteli.atrium.api.infix.en_GB instead.
ch.tutteli.atrium.api.cc.infix.en_UK.assertions.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_UK.assertions.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_UK.creating.charsequence.contains.builders	Contains `@Deprecated` builders, use the builders from package `en_GB`; will all be removed with 1.0.0
ch.tutteli.atrium.api.cc.infix.en_UK.creating.iterable.contains.builders	Contains `@Deprecated` builders, use the builders from package `en_GB`; will all be removed with 1.0.0
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.charsequence.contains.builders	Contains the builders - necessary to provide an extensible fluent API - which allow to create sophisticated `contains` assertions for CharSequence.
ch.tutteli.atrium.api.fluent.en_GB.creating.iterable.contains.builders	Contains the builders - necessary to provide an extensible fluent API - which allow to create sophisticated `contains` assertions for Iterable.
ch.tutteli.atrium.api.fluent.en_GB.jdk8	Contains an API for types introduced with JDK 8
ch.tutteli.atrium.api.fluent.en_GB.kotlin_1_3	Contains an API for types introduced with Kotlin 1.3
ch.tutteli.atrium.api.verbs	Contains the out-of-the-box Assertion Verbs such as expect, assert and assertThat.
ch.tutteli.atrium.api.verbs.internal	Contains the assertion verbs Atrium uses internally. Use with care, no backward compatibility guarantees and reporting might change.
ch.tutteli.atrium.assertions	Contains different types of Assertion, e.g. DescriptiveAssertion. Currently it contains also `@Deprecated` impl-functions which will be removed with 1.0.0
ch.tutteli.atrium.assertions.any.typetransformation	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.basic.contains	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.basic.contains.builders	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.basic.contains.checkers	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.basic.contains.creators	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
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.assertions.charsequence.contains	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.charsequence.contains.builders	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.charsequence.contains.checkers	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.charsequence.contains.creators	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.charsequence.contains.searchbehaviours	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.charsequence.contains.searchers	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.iterable.contains	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.iterable.contains.builders	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.iterable.contains.checkers	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.iterable.contains.creators	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.iterable.contains.searchbehaviours	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.throwable.thrown	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.throwable.thrown.builders	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.throwable.thrown.creators	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.assertions.throwable.thrown.providers	Contains `@Deprecated` classes/interfaces/functions, use the ones from package `creating`; will all be removed with 1.0.0
ch.tutteli.atrium.checking	Everything involved in checking Assertions.
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.domain.assertions.composers	The AssertionComposer which delegates to an implementation which composes different assertions to new Assertions.
ch.tutteli.atrium.domain.builders	Contains ExpectImpl.
ch.tutteli.atrium.domain.builders.creating
ch.tutteli.atrium.domain.builders.creating.basic.contains	Contains helper functions for Contains.Builder
ch.tutteli.atrium.domain.builders.creating.changers	Contains builders for ch.tutteli.atrium.domain.creating.changers.
ch.tutteli.atrium.domain.builders.creating.charsequence.contains.builders	Contains base classes for CharSequenceContains.CheckerOption.
ch.tutteli.atrium.domain.builders.creating.collectors	Contains the builder behind ExpectImpl.collector
ch.tutteli.atrium.domain.builders.creating.iterable.contains.builders	Contains base classes for IterableContains.CheckerOption.
ch.tutteli.atrium.domain.builders.kotlin_1_3	Builders involved in delegating to assertion implementations.
ch.tutteli.atrium.domain.builders.kotlin_1_3.creating	Builders involved in creating Assertions.
ch.tutteli.atrium.domain.builders.migration	Contains helper functions such as asExpect to ease the migration from deprecated functionality to new functionality
ch.tutteli.atrium.domain.builders.reporting	Contains the ReporterBuilder.
ch.tutteli.atrium.domain.builders.utils	Contains utility functions for APIs.
ch.tutteli.atrium.domain.creating	Contains interfaces defining the minimum set of assertion functions (on level domain) which an implementation has to provide.
ch.tutteli.atrium.domain.creating.any.typetransformation	Contains `@Deprecated` functionality in conjunction with `Assert` and type transformations; will all be removed with 1.0.0
ch.tutteli.atrium.domain.creating.any.typetransformation.creators	Contains `@Deprecated` functionality in conjunction with `Assert` and type transformations; will all be removed with 1.0.0
ch.tutteli.atrium.domain.creating.any.typetransformation.failurehandlers	Contains `@Deprecated` functionality in conjunction with `Assert` and type transformations; will all be removed with 1.0.0
ch.tutteli.atrium.domain.creating.basic.contains	Contains the basic contract for contains assertion builders -- Contains.
ch.tutteli.atrium.domain.creating.changers	Contains contracts for subject-change related functionality such as SubjectChanger and ExtractedFeaturePostStep
ch.tutteli.atrium.domain.creating.charsequence.contains	Contains the contract for sophisticated CharSequence `contains` assertions -- CharSequenceContains
ch.tutteli.atrium.domain.creating.charsequence.contains.checkers	Contains CheckerFactory which defines the minimum set of CharSequenceContains.Checker an implementation has to provide.
ch.tutteli.atrium.domain.creating.charsequence.contains.creators	Contains CharSequenceContainsAssertions which defines the minimum set of `CharSequence contains` assertion functions (on level domain) an implementation has to provide.
ch.tutteli.atrium.domain.creating.charsequence.contains.searchbehaviours	Contains SearchBehaviourFactory which defines the minimum set of CharSequenceContains.SearchBehaviour an implementation has to provide.
ch.tutteli.atrium.domain.creating.collectors	Contains AssertionCollector.
ch.tutteli.atrium.domain.creating.feature.extract	Contains the contract for sophisticated feature extraction assertions -- FeatureExtractor
ch.tutteli.atrium.domain.creating.feature.extract.creators	Contains the FeatureExtractorCreatorFactory
ch.tutteli.atrium.domain.creating.iterable.contains	Contains the contract for sophisticated Iterable `contains` assertions -- IterableContains
ch.tutteli.atrium.domain.creating.iterable.contains.checkers	Contains CheckerFactory which defines the minimum set of IterableContains.Checker an implementation has to provide.
ch.tutteli.atrium.domain.creating.iterable.contains.creators	Contains IterableContainsAssertions which defines the minimum set of `Iterable contains` assertion functions (on level domain) an implementation has to provide.
ch.tutteli.atrium.domain.creating.iterable.contains.searchbehaviours	Contains SearchBehaviourFactory which defines the minimum set of IterableContains.SearchBehaviour an implementation has to provide.
ch.tutteli.atrium.domain.creating.throwable.thrown	Contains the contract for sophisticated a Throwable was thrown assertions -- ThrowableThrown
ch.tutteli.atrium.domain.creating.throwable.thrown.creators	Contains IterableContainsAssertions which defines the minimum set of `a Throwable was thrown` assertion functions (on level domain) an implementation has to provide.
ch.tutteli.atrium.domain.creating.throwable.thrown.providers	Contains AbsentThrowableMessageProviderFactory which defines the minimum set of IterableContains.AbsentThrowableMessageProvider an implementation has to provide.
ch.tutteli.atrium.domain.kotlin_1_3.creating	Contains interfaces defining the minimum set of assertion functions (on level domain) which an implementation has to provide for the Kotlin 1.3 extension.
ch.tutteli.atrium.reporting	Everything involved in reporting Assertions.
ch.tutteli.atrium.reporting.translating	Everything involved in translating Translatables.
ch.tutteli.atrium.translations	Contains Translatables.
ch.tutteli.atrium.verbs	Contains the `@Deprecated` out-of-the-box Assertion Verbs for `Assert` which is itself `@Deprecated`.
ch.tutteli.atrium.verbs.assert	The `@Deprecated` version of the assertion verb `assert`; will be removed with 1.0.0
ch.tutteli.atrium.verbs.assertthat	The `@Deprecated` version of the assertion verb `assertThat`; will be removed with 1.0.0
ch.tutteli.atrium.verbs.expect	The `@Deprecated` version of the assertion verb `expect`; will be removed with 1.0.0
ch.tutteli.atrium.verbs.internal	Contains the `@Deprecated` assertion verbs Atrium used internally for `Assert`; will all be removed with 1.0.0.

Index

All Types