Atrium 0.6.0

doc

KDoc of Atrium

Atrium is built up by different modules. The packages shown below contain classes etc. of all modules excluding the one of atrium-imp-robstoll and atrium-imp-robstoll-lib.

Bundle modules:

atrium-cc-de_CH-robstoll defines to have a dependency on atrium-api-cc-de_CH, atrium-translations-de_CH and atrium-core-impl-robstoll
atrium-cc-en_UK-robstoll defines to have a dependency on atrium-api-cc-en_UK, atrium-translations-en_UK and atrium-core-impl-robstoll
atrium-cc-infix-en_UK-robstoll defines to have a dependency on atrium-api-cc-infix-en_UK, atrium-translations-en_UK and atrium-core-impl-robstoll

API modules:

atrium-api-cc-de_CH provides an assertion function API in German 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.
atrium-api-cc-en_UK 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.
atrium-api-cc-infix-en_UK 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.

Assertion modules:

atrium-assertions contains all impl-functions and builder templates which can be used to create an API. Moreover it contains the ReporterBuilder.
atrium-translations-de_CH provides translations in German for Translatables used in assertion functions.
atrium-translations-en_UK provides translations in English for Translatables used in assertion functions.
atrium-verbs contains out of the box assertion verbs (we suggest to use your own assertion verbs).

Core modules:

atrium-core-api defines the contracts of the core of Atrium.
atrium-core-api-late-binding defines the contract for AtriumFactory by providing a dummy implementation which eventually needs to be replaced by a real implementation.
atrium-core-impl-robstoll provides an AtriumFactory which uses the implementations of atrium-impl-robstoll-lib
atrium-core-impl-robstoll-lib robstoll's implementation of the core of Atrium.

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.

Packages

ch.tutteli.atrium	Contains the IAtriumFactory.
ch.tutteli.atrium.api.cc.de_CH	Contains API which provides a pure fluent API in German and which has its design focus on usability in conjunction with code completion.
ch.tutteli.atrium.api.cc.de_CH.assertions.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.cc.de_CH.assertions.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.cc.en_UK	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.cc.en_UK.assertions.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.cc.en_UK.assertions.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.cc.infix.en_UK	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.cc.infix.en_UK.assertions.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.cc.infix.en_UK.assertions.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.assertions	Contains different types of Assertion -- e.g. BasicDescriptiveAssertion -- as well as assertion function templates which can be used in API modules such as ch.tutteli.atrium.api.cc.en_UK.
ch.tutteli.atrium.assertions.any.typetransformation
ch.tutteli.atrium.assertions.basic.contains	Contains the basic contract for contains assertion builders -- Contains.
ch.tutteli.atrium.assertions.basic.contains.builders	Contains base classes for builders representing a step in the process of creating sophisticated `contains` assertions.
ch.tutteli.atrium.assertions.basic.contains.checkers	Contains base classes for Contains.Checker.
ch.tutteli.atrium.assertions.basic.contains.creators	Contains base classes for Contains.Creators.
ch.tutteli.atrium.assertions.charsequence.contains	Contains the contract for sophisticated CharSequence `contains` assertions -- CharSequenceContains
ch.tutteli.atrium.assertions.charsequence.contains.builders	Contains base classes for fluent API builders used in assertion function APIs (e.g. ch.tutteli.atrium.api.cc.infix.en_UK).
ch.tutteli.atrium.assertions.charsequence.contains.checkers	Contains CharSequenceContains.Checkers.
ch.tutteli.atrium.assertions.charsequence.contains.creators	Contains CharSequenceContains.Creators.
ch.tutteli.atrium.assertions.charsequence.contains.searchbehaviours	Contains CharSequenceContains.SearchBehaviour.
ch.tutteli.atrium.assertions.charsequence.contains.searchers	Contains CharSequenceContains.Searchers.
ch.tutteli.atrium.assertions.iterable.contains	Contains the contract for sophisticated Iterable `contains` assertions -- IterableContains
ch.tutteli.atrium.assertions.iterable.contains.builders	Contains base classes for fluent API builders used in assertion function APIs (e.g. ch.tutteli.atrium.api.cc.en_UK).
ch.tutteli.atrium.assertions.iterable.contains.checkers	Contains IterableContains.Checkers.
ch.tutteli.atrium.assertions.iterable.contains.creators	Contains IterableContains.Creators.
ch.tutteli.atrium.assertions.iterable.contains.searchbehaviours	Contains IterableContains.SearchBehaviour.
ch.tutteli.atrium.assertions.throwable.thrown	Contains the contract for sophisticated a Throwable was thrown assertions -- ThrowableThrown
ch.tutteli.atrium.assertions.throwable.thrown.builders	Contains the ThrowableThrownBuilder which typically is used to create an assertion verb for expected exceptions
ch.tutteli.atrium.assertions.throwable.thrown.creators	Contains ThrowableThrown.Creators.
ch.tutteli.atrium.assertions.throwable.thrown.providers	Contains IterableContains.AbsentThrowableMessageProviders.
ch.tutteli.atrium.checking	Everything involved in checking Assertion.
ch.tutteli.atrium.creating	Everything involved in creating Assertion.
ch.tutteli.atrium.reporting	Everything involved in reporting Assertion.
ch.tutteli.atrium.reporting.translating	Everything involved in translating Translatables.
ch.tutteli.atrium.spec	Helper functions for specifications as well as the contract of AssertionVerbFactory.
ch.tutteli.atrium.spec.assertions	Specifications for assertion function APIs (usually placed in an API module -- e.g. ch.tutteli.atrium.api.cc.de_CH).
ch.tutteli.atrium.spec.checking	Specifications for the API of the package ch.tutteli.atrium.checking.
ch.tutteli.atrium.spec.creating	Specifications for the API of the package ch.tutteli.atrium.creating.
ch.tutteli.atrium.spec.reporting	Specifications for the API of the package ch.tutteli.atrium.reporting.
ch.tutteli.atrium.spec.reporting.translating	Specifications for the API of the package ch.tutteli.atrium.reporting.translating.
ch.tutteli.atrium.spec.verbs	Specifications for Assertion Verbs.
ch.tutteli.atrium.verbs	Contains the AssertionVerb which is an enum defining the Translatable of the out-of-the-box Assertion Verbs.
ch.tutteli.atrium.verbs.assert	Contains the Assertion Verbs functions named `assert`.
ch.tutteli.atrium.verbs.assertthat	Contains the Assertion Verbs functions named `assertThat`.
ch.tutteli.atrium.verbs.expect	Contains the Assertion Verbs functions named `expect`.

Index

All Types