Atrium 0.4.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.

API modules:

atrium-cc-en_UK-robstoll can be used as "shortcut" -- it defines dependencies on atrium-api-code-completion-en_UK, atrium-translations-en_UK and atrium-core-impl-robstoll
atrium-api-code-completion-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.
atrium-api-code-completion-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.

Assertion modules:

atrium-assertions contains all functions which can be used to create assertions as well as the ReporterBuilder.
atrium-translations-de_CH provides translations in German for ITranslatables used in assertion functions.
atrium-translations-en_UK provides translations in English for ITranslatables 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 dummy implementations which are eventually replaced by an atrium 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 atrium.

Misc modules:

atrium-spec contains Spek specifications for interfaces (defined in atrium-core-api) and assertion functions which can be reused by Atrium implementations and assertion function API implementations to assure they fulfill the specifications.

Packages

ch.tutteli.atrium	Contains the IAtriumFactory.
ch.tutteli.atrium.api.cc.de_CH	Contains the code completion focused assertion function API in German.
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 the code completion focused assertion function API in English.
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.assertions	Contains different types of IAssertion -- e.g. BasicAssertion -- 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.narrow	Contains inter alia the contract for narrowing assertion builders -- IAnyNarrow.
ch.tutteli.atrium.assertions.any.narrow.failurehandler	Contains IDownCastFailureHandlers.
ch.tutteli.atrium.assertions.basic.contains	Contains the basic contract for contains assertion builders -- IContains.
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 IContains.IChecker.
ch.tutteli.atrium.assertions.basic.contains.creators	Contains base classes for IContains.ICreators.
ch.tutteli.atrium.assertions.charsequence.contains	Contains the contract for sophisticated CharSequence `contains` assertions -- ICharSequenceContains
ch.tutteli.atrium.assertions.charsequence.contains.builders	Contains base classes for fluent API builders used in assertion function APIs (e.g. atrium-assertions-code-completion-en_UK).
ch.tutteli.atrium.assertions.charsequence.contains.checkers	Contains ICharSequenceContains.ICheckers.
ch.tutteli.atrium.assertions.charsequence.contains.creators	Contains ICharSequenceContains.ICreators.
ch.tutteli.atrium.assertions.charsequence.contains.searchbehaviours	Contains ICharSequenceContains.ISearchBehaviour.
ch.tutteli.atrium.assertions.charsequence.contains.searchers	Contains ICharSequenceContains.ISearchers.
ch.tutteli.atrium.assertions.iterable.contains	Contains the contract for sophisticated Iterable `contains` assertions -- IIterableContains
ch.tutteli.atrium.assertions.iterable.contains.builders	Contains base classes for fluent API builders used in assertion function APIs (e.g. atrium-assertions-code-completion-en_UK).
ch.tutteli.atrium.assertions.iterable.contains.checkers	Contains IIterableContains.ICheckers.
ch.tutteli.atrium.assertions.iterable.contains.creators	Contains IIterableContains.ICreators.
ch.tutteli.atrium.assertions.iterable.contains.searchbehaviours	Contains IIterableContains.ISearchBehaviour.
ch.tutteli.atrium.assertions.throwable.thrown	Contains the contract for sophisticated a Throwable was thrown assertions -- IThrowableThrown
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 IThrowableThrown.ICreators.
ch.tutteli.atrium.assertions.throwable.thrown.providers	Contains IIterableContains.IAbsentThrowableMessageProviders.
ch.tutteli.atrium.checking	Everything involved in checking made IAssertion.
ch.tutteli.atrium.creating	Everything involved in creating IAssertion.
ch.tutteli.atrium.reporting	Everything involved in reporting made IAssertion.
ch.tutteli.atrium.reporting.translating	Everything involved in translating ITranslatables.
ch.tutteli.atrium.spec	Helper functions for specifications as well as the contract of IAssertionVerbFactory.
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 ITranslatable 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