Package-level declarations

Contains different types of Assertions.

Types

Link copied to clipboard
interface Assertion

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

Link copied to clipboard

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

Link copied to clipboard

Represents a type of an AssertionGroup.

Link copied to clipboard

A marker interface for types which can be used to identify bullet points.

Link copied to clipboard

The AssertionGroupType for AssertionGroups whose assertions are used to explain something rather than pointing something out -- accordingly the AssertionGroup.holds should always return true.

Link copied to clipboard

The AssertionGroupType for AssertionGroups which contain any kind of feature assertions.

Link copied to clipboard

The AssertionGroupType for AssertionGroups which contain assertions which shall be grouped.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

The base interface for Assertions which consist of a representation of an expected result with a complementary description.

Link copied to clipboard
Link copied to clipboard
annotation class ExperimentalExpectationApi(val reason: String = "")
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Represents the AssertionGroupType for AssertionGroups which contain some kind of feature assertions.

Link copied to clipboard

Represents the AssertionGroupType for AssertionGroups whose assertions all be reported in reporting (no filtering by a Reporter) since it represents a group of assertions made for (most likely) unrelated subjects.

Link copied to clipboard

The AssertionGroupType for AssertionGroups whose assertions are used to document a hint about the usage of the chosen function or rules in Atrium

Link copied to clipboard

The AssertionGroupType for AssertionGroups whose assertions are used to document the reason for one or multiple assertions.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Represents the identifier for bullet points used to prefix Assertions which do not hold, in context of an AssertionGroup with type SummaryAssertionGroupType.

Link copied to clipboard

Represents the identifier for bullet points used to prefix Assertions which hold, in context of an AssertionGroup with type SummaryAssertionGroupType.

Link copied to clipboard

The base interface for Assertions which only consist of a representation (next to holds).

Link copied to clipboard

The AssertionGroupType for AssertionGroups which are the root of all assertions.

Link copied to clipboard

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.

Link copied to clipboard

The AssertionGroupType for AssertionGroups whose assertions are used to state a warning rather than making an assumption.