doc / ch.tutteli.atrium.assertions / ExplanatoryAssertionGroupType

ExplanatoryAssertionGroupType

interface ExplanatoryAssertionGroupType : DoNotFilterAssertionGroupType (source)

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.

But they can return false in which case the corresponding group holding it should no longer hold either.

Inheritors

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.

InformationAssertionGroupType

data class InformationAssertionGroupType : ExplanatoryAssertionGroupType

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

WarningAssertionGroupType

object WarningAssertionGroupType : ExplanatoryAssertionGroupType

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