Atrium 0.3.0

doc

KDoc of Atrium

Atrium is split up in different modules. The packages shown below contain classes etc. of all modules excluding the once of atrium-imp-robstoll. Following a brief overview of the modules:

atrium-api defines the contracts of atrium
atrium-api-late-binding defines the contract for AtriumFactory and ThrowableFluent by providing dummy implementations which are eventually replaced by an atrium implementation.
- atrium-impl-common provides common classes for implementations of atrium -- this module is deprecated and will be removed in the next version
- atrium-impl-robstoll is an implementation of atrium and implements both, atrium-api as well as atrium-api-late-binding (hence provides a replacement for AtriumFactory and ThrowableFluent)
atrium-assertions contains all assertion functions as well as the ReporterBuilder.
atrium-spec contains Spek specifications for interfaces (defined in atrium-api) which can be reused by atrium implementations to assure they fulfill the specifications.
atrium-verb contains out of the box assertion verbs.

Packages

ch.tutteli.atrium	Contains the IAtriumFactory, all the assertion functions as well as the ITranslatables used in the assertion functions (e.g. DescriptionAnyAssertion)
ch.tutteli.atrium.assertions	Contains different types of IAssertion, e.g. IAssertionGroup etc.
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.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