doc / ch.tutteli.atrium.reporting

Package ch.tutteli.atrium.reporting

Everything involved in reporting Assertions.

Types

AssertionFormatter

interface AssertionFormatter

Represents a formatter for Assertions and AssertionGroups.

AssertionFormatterController

interface AssertionFormatterController

Responsible to control the flow of reporting using registered AssertionFormatters.

AssertionFormatterFacade

interface AssertionFormatterFacade

Responsible to call an appropriate AssertionFormatter which supports formating a given Assertion.

AssertionFormatterParameterObject

class AssertionFormatterParameterObject

A parameter object used for interactions between AssertionFormatterController and AssertionFormatter.

AssertionPairFormatter

interface AssertionPairFormatter

Represents a formatter of assertion pairs -- which consists of a Translatable and a representation.

AtriumErrorAdjuster

expect interface AtriumErrorAdjuster : AtriumErrorAdjusterCommon

Responsible to adjust a given Throwable (usually an AtriumError) for improved error reporting.

AtriumErrorAdjusterCommon

interface AtriumErrorAdjusterCommon

Defines the general contract for AtriumError adjusters which all platforms have to fulfil.

LazyRepresentation

class LazyRepresentation

A representation which shall be evaluated lazily during reporting.

MethodCallFormatter

interface MethodCallFormatter

Responsible to format a method call in reporting.

ObjectFormatter

interface ObjectFormatter

Represents a formatter for objects.

RawString

interface RawString

Marker interface for types which provide a raw string functionality and should be treated accordingly in reporting (e.g., in ObjectFormatter).

Reporter

interface Reporter

Represents a reporter which reports about Assertions.

ReporterBuilder

class ReporterBuilder

The deprecated builder to create a Reporter consisting of several components.

ReporterFactory

interface ReporterFactory

Responsible to create a Reporter.

StringBasedRawString

data class StringBasedRawString : RawString

Use this class to represent a String which should be treated as raw String in reporting.

Exceptions

AtriumError

expect class AtriumError : AssertionError

Indicates that an assertion made by Atrium failed.

Properties

BUG_REPORT_URL

const val BUG_REPORT_URL: String

Refers to the bug tracker of Atrium.

reporter

val reporter: Reporter

The access point to an implementation of Reporter.

SHOULD_NOT_BE_SHOWN_TO_THE_USER_BUG

const val SHOULD_NOT_BE_SHOWN_TO_THE_USER_BUG: String

Can be used in places where an argument for reporting is expected which should never be shown to the user.

SHOULD_NOT_BE_SHOWN_TO_THE_USER_BUG_TRANSLATABLE

val SHOULD_NOT_BE_SHOWN_TO_THE_USER_BUG_TRANSLATABLE: Untranslatable

Can be used in places where an argument of type Translatable is expected which should never be shown to the user.