ch.tutteli.atrium.assertions

Package ch.tutteli.atrium.assertions

Contains different types of Assertion, e.g. DescriptiveAssertion. Currently, it contains also @Deprecated types which will be made internal with 0.18.0 or earlier

Types

Assertion	`interface Assertion` The base interface of all assertions, providing the method holds.
AssertionGroup	`interface AssertionGroup : Assertion` The base interface for Assertion groups, providing a default implementation for Assertion.holds which returns `true` if all its assertions hold.
AssertionGroupType	`interface AssertionGroupType : BulletPointIdentifier` Represents a type of an AssertionGroup.
BulletPointIdentifier	`interface BulletPointIdentifier` A marker interface for types which can be used to identify bullet points.
DefaultExplanatoryAssertionGroupType	`object DefaultExplanatoryAssertionGroupType : ExplanatoryAssertionGroupType` The AssertionGroupType for AssertionGroups whose assertions are used to explain something rather than pointing something out -- accordingly the AssertionGroup.holds should always return `true`.
DefaultFeatureAssertionGroupType	`object DefaultFeatureAssertionGroupType : FeatureAssertionGroupType` The AssertionGroupType for AssertionGroups which contain any kind of feature assertions.
DefaultListAssertionGroupType	`object DefaultListAssertionGroupType : ListAssertionGroupType` The AssertionGroupType for AssertionGroups whose assertions should be displayed in a list.
DefaultSummaryAssertionGroupType	`object DefaultSummaryAssertionGroupType : SummaryAssertionGroupType` The AssertionGroupType for AssertionGroups whose assertions should not be filtered (by a Reporter) and for which an AssertionFormatter should state whether they hold or not.
DescriptiveAssertion	`interface DescriptiveAssertion : Assertion` The base interface for Assertions which consist of a representation of an expected result with a complementary description.
DoNotFilterAssertionGroupType	`interface DoNotFilterAssertionGroupType : AssertionGroupType` An AssertionGroupType which indicates that a Reporter should not filter its AssertionGroup.assertions.
ExplanatoryAssertion	`interface ExplanatoryAssertion : Assertion` Represents an Assertion which can be used to explain/show an instance which is eventually formatted by an ObjectFormatter in reporting -- it needs to be a child of an AssertionGroup with an ExplanatoryAssertionGroupType.
ExplanatoryAssertionGroupType	`interface ExplanatoryAssertionGroupType : DoNotFilterAssertionGroupType` Represents the AssertionGroupType for AssertionGroups whose assertions are mainly used to explain something -- hence in the normal case it should not be of importance whether they hold or not and thus such AssertionGroups should usually return `true` for holds.
FeatureAssertionGroupType	`interface FeatureAssertionGroupType : AssertionGroupType` Represents the AssertionGroupType for AssertionGroups which contain some kind of feature assertions.
InformationAssertionGroupType	`data class InformationAssertionGroupType : ExplanatoryAssertionGroupType` The AssertionGroupType for AssertionGroups whose assertions are used to document the reason for one or multiple assertions.
InvisibleAssertionGroupType	`object InvisibleAssertionGroupType : AssertionGroupType` Represents the AssertionGroupType for AssertionGroups whose assertions should be displayed in a manner that the user does not even notice that the Assertions have been grouped.
ListAssertionGroupType	`interface ListAssertionGroupType : AssertionGroupType` Represents the AssertionGroupType for AssertionGroups whose assertions should be displayed in a list (up to the Reporter if it is a list with bullets, squares etc.).
PrefixFailingSummaryAssertion	`class PrefixFailingSummaryAssertion : BulletPointIdentifier` Represents the identifier for bullet points used to prefix Assertions which do not hold, in context of an AssertionGroup with type SummaryAssertionGroupType.
PrefixFeatureAssertionGroupHeader	`class PrefixFeatureAssertionGroupHeader : BulletPointIdentifier` This class is only used as BulletPointIdentifier.
PrefixSuccessfulSummaryAssertion	`class PrefixSuccessfulSummaryAssertion : BulletPointIdentifier` Represents the identifier for bullet points used to prefix Assertions which hold, in context of an AssertionGroup with type SummaryAssertionGroupType.
RepresentationOnlyAssertion	`interface RepresentationOnlyAssertion : Assertion` The base interface for Assertions which only consist of a representation (next to holds).
RootAssertionGroupType	`object RootAssertionGroupType : AssertionGroupType` The AssertionGroupType for AssertionGroups which are the root of all assertions.
SummaryAssertionGroupType	`interface SummaryAssertionGroupType : DoNotFilterAssertionGroupType` Represents the AssertionGroupType for AssertionGroups whose assertions should all be reported in reporting (no filtering by a Reporter) since it represents a summary which itself will point out which assertions hold and which do not.
WarningAssertionGroupType	`object WarningAssertionGroupType : ExplanatoryAssertionGroupType` The AssertionGroupType for AssertionGroups whose assertions are used to state a warning rather than making an assumption.