doc / ch.tutteli.atrium.reporting / AssertionFormatter

AssertionFormatter

interface AssertionFormatter (source)

Represents a formatter for Assertions and AssertionGroups.

Functions

canFormat

abstract fun canFormat(assertion: Assertion): Boolean

Denotes whether this AssertionFormatter was created to format Assertions such as the given assertion or not.

format

open fun format(assertion: Assertion, parameterObject: AssertionFormatterParameterObject): Unit

Formats the given assertion and appends the result to the sb of the given parameterObject.

formatGroup

abstract fun formatGroup(assertionGroup: AssertionGroup, parameterObject: AssertionFormatterParameterObject, formatAssertions: (AssertionFormatterParameterObject, (Assertion) -> Unit) -> Unit): Unit

Formats the given assertionGroup and appends the result to the sb of the given parameterObject.

formatNonGroup

abstract fun formatNonGroup(assertion: Assertion, parameterObject: AssertionFormatterParameterObject): Unit

Formats the given assertion and appends the result to the sb of the given parameterObject.

Companion Object Properties

CALL_FORMAT_GROUP

val CALL_FORMAT_GROUP: String

Companion Object Functions

throwNotIntendedForAssertionGroups

fun throwNotIntendedForAssertionGroups(): Unit