doc / ch.tutteli.atrium.assertions / ExplanatoryAssertion

ExplanatoryAssertion

interface ExplanatoryAssertion : Assertion

Represents an Assertion which is typically used in an AssertionGroup with a ExplanatoryAssertionGroupType and provides an explanation which is typically formatted by an ObjectFormatter in reporting.

It is not of importance whether the assertions holds or not and thus it overrides holds and return always true.

Properties

explanation

abstract val explanation: Any?

The object used to explain something.

Functions

holds

open fun holds(): Boolean

Always true since it should not matter whether an ExplanatoryAssertion holds or not.

Inheritors

BasicExplanatoryAssertion

class BasicExplanatoryAssertion : ExplanatoryAssertion

A default implementation for ExplanatoryAssertion -- an assertion which only wants to give an explanation.