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:

API modules:

Domain modules:

Core modules:

Translation modules:

Misc modules:

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

Packages

ch.tutteli.atrium

Contains the deprecated 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 @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 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.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.cc.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.cc.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.cc.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.cc.en_UK

@Depreacted API use ch.tutteli.atrium.api.cc.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

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_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.cc.infix.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.cc.infix.en_GB.creating.list.get.builders

Contains the builders - necessary to provide an extensible fluent API - which allow to create sophisticated get assertions for List.

ch.tutteli.atrium.api.cc.infix.en_GB.creating.map.get.builders

Contains the builders - necessary to provide an extensible fluent API - which allow to create sophisticated get assertions for Map.

ch.tutteli.atrium.api.cc.infix.en_GB.keywords

Contains pseudo keywords such as order.

ch.tutteli.atrium.api.cc.infix.en_UK

@Depreacted API use ch.tutteli.atrium.api.cc.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.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.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 AssertImpl.

ch.tutteli.atrium.domain.builders.assertions.builders

Contains extension functions for the AssertionBuilder.

ch.tutteli.atrium.domain.builders.creating

Builders involved in creating Assertions.

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 AssertImpl.collector

ch.tutteli.atrium.domain.builders.creating.iterable.contains.builders

Contains base classes for IterableContains.CheckerOption.

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 inter alia the contract for the type transformation assertion builders -- AnyTypeTransformation.

ch.tutteli.atrium.domain.creating.any.typetransformation.creators

Contains AnyTypeTransformationAssertions which defines the minimum set of type transformation assertion functions (on level domain) an implementation has to provide.

ch.tutteli.atrium.domain.creating.any.typetransformation.failurehandlers

Contains the contract for failure handlers involved in failed type transformations as well as the FailureHandlerFactory which defines the minimum set of AnyTypeTransformation.FailureHandler an implementation has to provide.

ch.tutteli.atrium.domain.creating.basic.contains

Contains the basic contract for contains assertion builders -- Contains.

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.reporting

Everything involved in reporting Assertions.

ch.tutteli.atrium.reporting.translating

Everything involved in translating Translatables.

ch.tutteli.atrium.spec

Contains inter alia DeprecationTestEngine which is used in backward compatibility tests.

ch.tutteli.atrium.translations

Contains Translatables.

ch.tutteli.atrium.verbs

Contains the out-of-the-box Assertion Verbs such as assert, assertThat and expect.

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 assertion verbs Atrium uses internally. Use with care, no backward compatibility guarantees and reporting might change.

Index

All Types