KDoc of Atrium

All Types

ch.tutteli.atrium.reporting.translating.ArgumentsSupportingTranslator

Represents an ITranslator which supports ITranslatableWithArgs.

ch.tutteli.atrium.spec.creating.AssertionPlantCheckLazilySpec
ch.tutteli.atrium.spec.creating.AssertionPlantNullableSpec
ch.tutteli.atrium.verbs.AssertionVerb

The ITranslatables for the assertion functions assert, assertThat and expect.

ch.tutteli.atrium.AtriumFactory

A dummy implementation of IAtriumFactory which should be replaced by an actual implementation.

ch.tutteli.atrium.DescriptionAnyAssertion

Contains the Message.descriptions of the assertion functions which are applicable to Any.

ch.tutteli.atrium.DescriptionCharSequenceAssertion

Contains the Message.descriptions of the assertion functions which are applicable to CharSequence.

ch.tutteli.atrium.DescriptionCollectionAssertion

Contains the Message.descriptions of the assertion functions which are applicable to Collection.

ch.tutteli.atrium.DescriptionNarrowingAssertion

Contains the Message.descriptions of the assertion functions which postulate that a IAssertionPlant.subject of type T can be narrowed to TSub where TSub <: T.

ch.tutteli.atrium.DescriptionNumberAssertion

Contains the Message.descriptions of the assertion functions which are applicable to Number.

ch.tutteli.atrium.spec.creating.DownCastBuilderSpec
ch.tutteli.atrium.spec.checking.FeatureAssertionCheckerSpec
ch.tutteli.atrium.assertions.IAssertion

The base interface of all assertions, providing the method holds.

ch.tutteli.atrium.checking.IAssertionChecker

Checks given IAssertions and reports if one of them fails.

ch.tutteli.atrium.reporting.IAssertionFormatter

Represents a formatter for an IAssertion and its Messages.

ch.tutteli.atrium.assertions.IAssertionGroup

The base interface for IAssertion groups, providing a default implementation for IAssertion.holds which returns true if all its assertions hold.

ch.tutteli.atrium.creating.IAssertionPlant

Represents a plant for IAssertions and offers the possibility to check all the added assertions.

ch.tutteli.atrium.creating.IAssertionPlantNullable

Represents an assertion plant for nullable types.

ch.tutteli.atrium.creating.IAssertionPlantWithCommonFields

An assertion plant which has CommonFields; provides the property subject for ease of use.

ch.tutteli.atrium.spec.IAssertionVerbFactory
ch.tutteli.atrium.IAtriumFactory

The minimum contract of the 'abstract factory' of atrium.

ch.tutteli.atrium.creating.IDownCastBuilder

A builder for creating a down-casting IAssertion.

ch.tutteli.atrium.assertions.IFeatureAssertionGroup

The base interface for feature IAssertion groups, providing a default implementation for IAssertion.holds which returns true if all its assertions hold.

ch.tutteli.atrium.reporting.translating.ILocaleOrderDecider

Responsible to decide in which order Locales should be processed.

ch.tutteli.atrium.reporting.IMethodCallFormatter

Responsible to format a method call in reporting.

ch.tutteli.atrium.assertions.IMultiMessageAssertion

The base interface for IAssertions which have multiple Messages.

ch.tutteli.atrium.reporting.IObjectFormatter

Represents a formatter for objects.

ch.tutteli.atrium.assertions.IOneMessageAssertion

The base interface for IAssertions which have one Message.

ch.tutteli.atrium.reporting.IRawString

Marker interface for types which provide a raw string functionality and should be treated accordingly in reporting (e.g., in IObjectFormatter).

ch.tutteli.atrium.reporting.IReporter

Represents a reporter which reports about IAssertions.

ch.tutteli.atrium.reporting.translating.ISimpleTranslatable

Something which is ITranslatable and provides a default representation by value.

ch.tutteli.atrium.creating.IThrowableFluent

This interface is mainly here to simplify the KDoc generation (no need to define it twice, once in atrium-api-late-binding and once in atrium-impl-robstoll). Once Kotlin supports inline functions in interfaces, we will consolidate it to a proper API and get rid of ThrowableFluent in atrium-api-late-binding.

ch.tutteli.atrium.reporting.translating.ITranslatable

Something which is translatable, identified by id with a default representation given by getDefault.

ch.tutteli.atrium.reporting.translating.ITranslatableWithArgs

Represents a ITranslatable with arguments.

ch.tutteli.atrium.reporting.translating.ITranslationSupplier

A supplier of translations for ITranslatables for particular Locales.

ch.tutteli.atrium.reporting.translating.ITranslator

Represents a translator of ITranslatables.

ch.tutteli.atrium.assertions.Message

Represents a message of an IAssertion.

ch.tutteli.atrium.spec.reporting.MethodCallFormatterSpec
ch.tutteli.atrium.spec.reporting.OnlyFailureReporterSpec
ch.tutteli.atrium.reporting.RawString

Use this class to represent a String which should be treated as raw String in reporting.

ch.tutteli.atrium.reporting.ReporterBuilder

A builder to create an IReporter consisting of an ITranslator which is used by an IObjectFormatter which then is used by an IAssertionFormatter which in turn is used by the created IReporter.

ch.tutteli.atrium.spec.reporting.SameLineAssertionMessageFormatterSpec
ch.tutteli.atrium.creating.ThrowableFluent

Provides toThrow methods for making assertions about a Throwable which one expects was thrown.

ch.tutteli.atrium.spec.creating.ThrowableFluentSpec
ch.tutteli.atrium.spec.checking.ThrowingAssertionCheckerSpec
ch.tutteli.atrium.spec.reporting.ToStringObjectFormatter
ch.tutteli.atrium.reporting.translating.TranslatableRawString

Use this class to represent an ITranslatable which shall be translated and then be treated as raw String in reporting.

ch.tutteli.atrium.reporting.translating.TranslatableWithArgs

An ITranslatable which contains placeholders for arguments.

ch.tutteli.atrium.spec.reporting.translating.TranslationSupplierSpec

If you use this Spec then your reporter needs to use a translator which uses the following translations which should be in

ch.tutteli.atrium.spec.reporting.translating.TranslatorSpec
ch.tutteli.atrium.reporting.translating.Untranslatable

Represents an ITranslatable which is not translatable but has only a fixed name which serves as getDefault.

ch.tutteli.atrium.reporting.translating.UsingDefaultTranslator

This translator does not translate but uses ITranslatable.getDefault instead and uses Locale.getDefault as primaryLocale if not defined differently via constructor parameter.

ch.tutteli.atrium.spec.verbs.VerbSpec