doc / ch.tutteli.atrium.assertions / IExplanatoryAssertion

IExplanatoryAssertion

interface IExplanatoryAssertion : IAssertion

Represents an IAssertion which is typically used in an IAssertionGroup with a IExplanatoryAssertionGroupType and provides an explanation which is typically formatted by an IObjectFormatter 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 IExplanatoryAssertion holds or not.

Inheritors

ExplanatoryAssertion

class ExplanatoryAssertion : IExplanatoryAssertion

Represents an assertion which only wants to give an explanation