doc

KDoc of Atrium

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

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

Bundle modules:

API modules:

Logic modules:

Core modules:

Translation modules:

Misc modules:

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

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 jdk8 - @Deprecated though as it was merged into ch.tutteli.atrium.api.fluent.en_GB.

ch.tutteli.atrium.api.fluent.en_GB.kotlin_1_3

Contains an API for types introduced with Kotlin 1.3

ch.tutteli.atrium.api.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.infix.en_GB.creating

Contains parameter objects .

ch.tutteli.atrium.api.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.infix.en_GB.creating.feature

Contains parameter objects related to feature assertions.

ch.tutteli.atrium.api.infix.en_GB.creating.iterable

Contains parameter objects related to Iterable.

ch.tutteli.atrium.api.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.infix.en_GB.creating.map

Contains parameter objects related to Map.

ch.tutteli.atrium.api.infix.en_GB.creating.path

Contains parameter objects related to Path.

ch.tutteli.atrium.api.infix.en_GB.kotlin_1_3

Contains an API for types introduced with Kotlin 1.3

ch.tutteli.atrium.api.infix.en_GB.workaround

Contains functions necessary for the infix API to work due to Kotlin related bugs / or insufficient type inference capabilities .

ch.tutteli.atrium.api.verbs

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

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

Builders involved in delegating to assertion implementations.

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.creating.typeutils

Type aliases to improve the API.

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

Contains all the assertion interfaces (e.g. AnyAssertions as well as _logic and helper functions for AssertionContainer

ch.tutteli.atrium.logic.assertions.impl

ch.tutteli.atrium.logic.creating.basic.contains

Contains the abstract contract sophisticated contains assertion builders: Contains

ch.tutteli.atrium.logic.creating.basic.contains.checkers

Contains interfaces implementing Contains.Checker

ch.tutteli.atrium.logic.creating.basic.contains.checkers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.basic.contains.checkers.

ch.tutteli.atrium.logic.creating.basic.contains.creators.impl

Contains base classes which can be handy to implement Contains.Creator

ch.tutteli.atrium.logic.creating.charsequence.contains

Contains the contract for sophisticated CharSequence.contains assertion builders: CharSequenceContains

ch.tutteli.atrium.logic.creating.charsequence.contains.checkers

Contains interfaces implementing CharSequence.Checker

ch.tutteli.atrium.logic.creating.charsequence.contains.checkers.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.checkers.

ch.tutteli.atrium.logic.creating.charsequence.contains.creators

Contains CharSequenceContainsAssertions which defines the minimum set of CharSequence.Creators an implementation has to deliver as well as some extension functions which delegate to those.

ch.tutteli.atrium.logic.creating.charsequence.contains.creators.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.creators.

ch.tutteli.atrium.logic.creating.charsequence.contains.searchbehaviours

Contains interfaces implementing CharSequence.SearchBehaviour

ch.tutteli.atrium.logic.creating.charsequence.contains.searchbehaviours.impl

Contains default implementations for the interfaces defined in ch.tutteli.atrium.logic.creating.charsequence.contains.searchbehaviours.

ch.tutteli.atrium.logic.creating.charsequence.contains.searchers.impl

Contains implementations of CharSequence.Searcher

ch.tutteli.atrium.logic.creating.charsequence.contains.steps

Contains steps for sophisticated CharSequence.contains assertion builders.

ch.tutteli.atrium.logic.creating.filesystem

ch.tutteli.atrium.logic.creating.filesystem.hints

ch.tutteli.atrium.logic.creating.iterable.contains

ch.tutteli.atrium.logic.creating.iterable.contains.checkers

ch.tutteli.atrium.logic.creating.iterable.contains.checkers.impl

ch.tutteli.atrium.logic.creating.iterable.contains.creators

ch.tutteli.atrium.logic.creating.iterable.contains.creators.impl

ch.tutteli.atrium.logic.creating.iterable.contains.searchbehaviours

ch.tutteli.atrium.logic.creating.iterable.contains.searchbehaviours.impl

ch.tutteli.atrium.logic.creating.iterable.contains.steps

ch.tutteli.atrium.logic.creating.iterable.contains.steps.impl

ch.tutteli.atrium.logic.creating.maplike.contains

ch.tutteli.atrium.logic.creating.maplike.contains.checkers

ch.tutteli.atrium.logic.creating.maplike.contains.checkers.impl

ch.tutteli.atrium.logic.creating.maplike.contains.creators

ch.tutteli.atrium.logic.creating.maplike.contains.creators.impl

ch.tutteli.atrium.logic.creating.maplike.contains.searchbehaviours

ch.tutteli.atrium.logic.creating.maplike.contains.searchbehaviours.impl

ch.tutteli.atrium.logic.creating.maplike.contains.steps

ch.tutteli.atrium.logic.creating.maplike.contains.steps.impl

ch.tutteli.atrium.logic.creating.transformers

ch.tutteli.atrium.logic.creating.transformers.impl

ch.tutteli.atrium.logic.creating.transformers.impl.featureextractor

ch.tutteli.atrium.logic.creating.transformers.impl.subjectchanger

ch.tutteli.atrium.logic.creating.typeutils

ch.tutteli.atrium.logic.creating.typeutils.impl

ch.tutteli.atrium.logic.impl

Contains default implementations of the assertion interfaces defined in ch.tutteli.atrium.logic.

ch.tutteli.atrium.logic.kotlin_1_3

Contains all the assertion interfaces for the Kotlin 1.3 extension (e.g. ResultAssertions

ch.tutteli.atrium.logic.kotlin_1_3.impl

Contains default implementations of the assertion interfaces defined in ch.tutteli.atrium.logic.kotlin_1_3.

ch.tutteli.atrium.logic.utils

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